Optimus Cards Rest APIs

Account

closeAccount

Close account record

Method used to close the Account and cancel all related Cards.


/holdings/accounts/CloseAccount/{externalAccountID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/CloseAccount/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CloseAccountRequestBody payload = ; // CloseAccountRequestBody | body Payload
        try {
            CloseAccountResponse result = apiInstance.closeAccount(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#closeAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CloseAccountRequestBody payload = ; // CloseAccountRequestBody | body Payload
        try {
            CloseAccountResponse result = apiInstance.closeAccount(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#closeAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
CloseAccountRequestBody *payload = ; // body Payload

AccountApi *apiInstance = [[AccountApi alloc] init];

// Close account record
[apiInstance closeAccountWith:externalAccountID
    requestID:requestID
    payload:payload
              completionHandler: ^(CloseAccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {CloseAccountRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.closeAccount(externalAccountID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class closeAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new CloseAccountRequestBody(); // CloseAccountRequestBody | body Payload

            try
            {
                // Close account record
                CloseAccountResponse result = apiInstance.closeAccount(externalAccountID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.closeAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // CloseAccountRequestBody | body Payload

try {
    $result = $api_instance->closeAccount($externalAccountID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->closeAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::CloseAccountRequestBody->new(); # CloseAccountRequestBody | body Payload

eval { 
    my $result = $api_instance->closeAccount(externalAccountID => $externalAccountID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->closeAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # CloseAccountRequestBody | body Payload

try: 
    # Close account record
    api_response = api_instance.close_account(externalAccountID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->closeAccount: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - CloseAccountResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


createAccount

New account record

Method used to create a Customer record in Optimus Optimus Cards system.


/holdings/accounts/CreateAccount/{externalCustomerID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/CreateAccount/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateAccountRequestBody payload = ; // CreateAccountRequestBody | body Payload
        try {
            CreateAccountResponse result = apiInstance.createAccount(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#createAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateAccountRequestBody payload = ; // CreateAccountRequestBody | body Payload
        try {
            CreateAccountResponse result = apiInstance.createAccount(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#createAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
CreateAccountRequestBody *payload = ; // body Payload

AccountApi *apiInstance = [[AccountApi alloc] init];

// New account record
[apiInstance createAccountWith:externalCustomerID
    requestID:requestID
    payload:payload
              completionHandler: ^(CreateAccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalCustomerID = externalCustomerID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {CreateAccountRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccount(externalCustomerID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalCustomerID = externalCustomerID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new CreateAccountRequestBody(); // CreateAccountRequestBody | body Payload

            try
            {
                // New account record
                CreateAccountResponse result = apiInstance.createAccount(externalCustomerID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.createAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalCustomerID = externalCustomerID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // CreateAccountRequestBody | body Payload

try {
    $result = $api_instance->createAccount($externalCustomerID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->createAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalCustomerID = externalCustomerID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::CreateAccountRequestBody->new(); # CreateAccountRequestBody | body Payload

eval { 
    my $result = $api_instance->createAccount(externalCustomerID => $externalCustomerID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->createAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalCustomerID = externalCustomerID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # CreateAccountRequestBody | body Payload

try: 
    # New account record
    api_response = api_instance.create_account(externalCustomerID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->createAccount: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - CreateAccountResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getAccountDetails

Retrieve account details

Method used to retrieve current information held in Optimus CMS about specific Account.


/holdings/accounts/GetAccountDetails/{externalAccountID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/GetAccountDetails/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetAccountDetailsResponse result = apiInstance.getAccountDetails(externalAccountID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetAccountDetailsResponse result = apiInstance.getAccountDetails(externalAccountID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

AccountApi *apiInstance = [[AccountApi alloc] init];

// Retrieve account details
[apiInstance getAccountDetailsWith:externalAccountID
    requestID:requestID
              completionHandler: ^(GetAccountDetailsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountDetails(externalAccountID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountDetailsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve account details
                GetAccountDetailsResponse result = apiInstance.getAccountDetails(externalAccountID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getAccountDetails($externalAccountID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getAccountDetails(externalAccountID => $externalAccountID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve account details
    api_response = api_instance.get_account_details(externalAccountID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountDetails: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetAccountDetailsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getAccountStatement

Request account statement production

Method used to generate the production of regular or fee statement for specific account.


/holdings/accounts/GetStatement/{externalAccountID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/GetStatement/{externalAccountID}?requestID=&startDate=&endDate=&type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        String startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
        String endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
        String type = type_example; // String | Type of statement to be generated: REGULAR or FEE
        try {
            GetStatementResponse result = apiInstance.getAccountStatement(externalAccountID, requestID, startDate, endDate, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountStatement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        String startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
        String endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
        String type = type_example; // String | Type of statement to be generated: REGULAR or FEE
        try {
            GetStatementResponse result = apiInstance.getAccountStatement(externalAccountID, requestID, startDate, endDate, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountStatement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *externalAccountID = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
String *startDate = startDate_example; // The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional)
String *endDate = endDate_example; // The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional)
String *type = type_example; // Type of statement to be generated: REGULAR or FEE (optional)

AccountApi *apiInstance = [[AccountApi alloc] init];

// Request account statement production
[apiInstance getAccountStatementWith:externalAccountID
    requestID:requestID
    startDate:startDate
    endDate:endDate
    type:type
              completionHandler: ^(GetStatementResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var opts = { 
  'startDate': startDate_example, // {String} The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
  'endDate': endDate_example, // {String} The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
  'type': type_example // {String} Type of statement to be generated: REGULAR or FEE
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountStatement(externalAccountID, requestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountStatementExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var startDate = startDate_example;  // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional) 
            var endDate = endDate_example;  // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional) 
            var type = type_example;  // String | Type of statement to be generated: REGULAR or FEE (optional) 

            try
            {
                // Request account statement production
                GetStatementResponse result = apiInstance.getAccountStatement(externalAccountID, requestID, startDate, endDate, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountStatement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
$endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
$type = type_example; // String | Type of statement to be generated: REGULAR or FEE

try {
    $result = $api_instance->getAccountStatement($externalAccountID, $requestID, $startDate, $endDate, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountStatement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $startDate = startDate_example; # String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
my $endDate = endDate_example; # String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
my $type = type_example; # String | Type of statement to be generated: REGULAR or FEE

eval { 
    my $result = $api_instance->getAccountStatement(externalAccountID => $externalAccountID, requestID => $requestID, startDate => $startDate, endDate => $endDate, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountStatement: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
startDate = startDate_example # String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional)
endDate = endDate_example # String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional)
type = type_example # String | Type of statement to be generated: REGULAR or FEE (optional)

try: 
    # Request account statement production
    api_response = api_instance.get_account_statement(externalAccountID, requestID, startDate=startDate, endDate=endDate, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountStatement: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required
startDate
String (yyyymmdd)
The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
endDate
String (yyyymmdd)
The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
type
String
Type of statement to be generated: REGULAR or FEE

Responses

Status: 200 - GetStatementResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getAccountTransactions

Retrieve account transactions

Method used to retrieve transaction history for a specific account.


/holdings/accounts/GetTransactions/{externalAccountID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/GetTransactions/{externalAccountID}?requestID=&pageNumber=&pageSize=&startDate=&endDate=&amountFrom=&amountTo=&counterparty=&sign="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        String startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
        String endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
        BigDecimal amountFrom = 8.14; // BigDecimal | Filter by amounts greater than or equal to given value
        Integer amountTo = 56; // Integer | Filter by amounts less than or equal to given value
        String counterparty = counterparty_example; // String | Filter by counterparty name
        String sign = sign_example; // String | Filter by debits or credits
        try {
            GetTransactionsResponse result = apiInstance.getAccountTransactions(externalAccountID, requestID, pageNumber, pageSize, startDate, endDate, amountFrom, amountTo, counterparty, sign);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountTransactions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        String startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
        String endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
        BigDecimal amountFrom = 8.14; // BigDecimal | Filter by amounts greater than or equal to given value
        Integer amountTo = 56; // Integer | Filter by amounts less than or equal to given value
        String counterparty = counterparty_example; // String | Filter by counterparty name
        String sign = sign_example; // String | Filter by debits or credits
        try {
            GetTransactionsResponse result = apiInstance.getAccountTransactions(externalAccountID, requestID, pageNumber, pageSize, startDate, endDate, amountFrom, amountTo, counterparty, sign);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getAccountTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *externalAccountID = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Integer *pageNumber = 56; // The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
Integer *pageSize = 56; // The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)
String *startDate = startDate_example; // The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional)
String *endDate = endDate_example; // The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional)
BigDecimal *amountFrom = 8.14; // Filter by amounts greater than or equal to given value (optional)
Integer *amountTo = 56; // Filter by amounts less than or equal to given value (optional)
String *counterparty = counterparty_example; // Filter by counterparty name (optional)
String *sign = sign_example; // Filter by debits or credits (optional)

AccountApi *apiInstance = [[AccountApi alloc] init];

// Retrieve account transactions
[apiInstance getAccountTransactionsWith:externalAccountID
    requestID:requestID
    pageNumber:pageNumber
    pageSize:pageSize
    startDate:startDate
    endDate:endDate
    amountFrom:amountFrom
    amountTo:amountTo
    counterparty:counterparty
    sign:sign
              completionHandler: ^(GetTransactionsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var opts = { 
  'pageNumber': 56, // {Integer} The page number to control returned results into manageable sets. Default to 1 if not supplied.
  'pageSize': 56, // {Integer} The page size to control returned results into manageable sets. Default to 5 if not supplied.
  'startDate': startDate_example, // {String} The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
  'endDate': endDate_example, // {String} The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
  'amountFrom': 8.14, // {BigDecimal} Filter by amounts greater than or equal to given value
  'amountTo': 56, // {Integer} Filter by amounts less than or equal to given value
  'counterparty': counterparty_example, // {String} Filter by counterparty name
  'sign': sign_example // {String} Filter by debits or credits
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountTransactions(externalAccountID, requestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountTransactionsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var pageNumber = 56;  // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional) 
            var pageSize = 56;  // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional) 
            var startDate = startDate_example;  // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional) 
            var endDate = endDate_example;  // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional) 
            var amountFrom = 8.14;  // BigDecimal | Filter by amounts greater than or equal to given value (optional) 
            var amountTo = 56;  // Integer | Filter by amounts less than or equal to given value (optional) 
            var counterparty = counterparty_example;  // String | Filter by counterparty name (optional) 
            var sign = sign_example;  // String | Filter by debits or credits (optional) 

            try
            {
                // Retrieve account transactions
                GetTransactionsResponse result = apiInstance.getAccountTransactions(externalAccountID, requestID, pageNumber, pageSize, startDate, endDate, amountFrom, amountTo, counterparty, sign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getAccountTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
$pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
$startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
$endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
$amountFrom = 8.14; // BigDecimal | Filter by amounts greater than or equal to given value
$amountTo = 56; // Integer | Filter by amounts less than or equal to given value
$counterparty = counterparty_example; // String | Filter by counterparty name
$sign = sign_example; // String | Filter by debits or credits

try {
    $result = $api_instance->getAccountTransactions($externalAccountID, $requestID, $pageNumber, $pageSize, $startDate, $endDate, $amountFrom, $amountTo, $counterparty, $sign);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getAccountTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $pageNumber = 56; # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
my $pageSize = 56; # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
my $startDate = startDate_example; # String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
my $endDate = endDate_example; # String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
my $amountFrom = 8.14; # BigDecimal | Filter by amounts greater than or equal to given value
my $amountTo = 56; # Integer | Filter by amounts less than or equal to given value
my $counterparty = counterparty_example; # String | Filter by counterparty name
my $sign = sign_example; # String | Filter by debits or credits

eval { 
    my $result = $api_instance->getAccountTransactions(externalAccountID => $externalAccountID, requestID => $requestID, pageNumber => $pageNumber, pageSize => $pageSize, startDate => $startDate, endDate => $endDate, amountFrom => $amountFrom, amountTo => $amountTo, counterparty => $counterparty, sign => $sign);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getAccountTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
pageNumber = 56 # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
pageSize = 56 # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)
startDate = startDate_example # String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional)
endDate = endDate_example # String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional)
amountFrom = 8.14 # BigDecimal | Filter by amounts greater than or equal to given value (optional)
amountTo = 56 # Integer | Filter by amounts less than or equal to given value (optional)
counterparty = counterparty_example # String | Filter by counterparty name (optional)
sign = sign_example # String | Filter by debits or credits (optional)

try: 
    # Retrieve account transactions
    api_response = api_instance.get_account_transactions(externalAccountID, requestID, pageNumber=pageNumber, pageSize=pageSize, startDate=startDate, endDate=endDate, amountFrom=amountFrom, amountTo=amountTo, counterparty=counterparty, sign=sign)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getAccountTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required
pageNumber
Integer
The page number to control returned results into manageable sets. Default to 1 if not supplied.
pageSize
Integer
The page size to control returned results into manageable sets. Default to 5 if not supplied.
startDate
String (yyyymmdd)
The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
endDate
String (yyyymmdd)
The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
amountFrom
BigDecimal
Filter by amounts greater than or equal to given value
amountTo
Integer
Filter by amounts less than or equal to given value
counterparty
String (yyyymmdd)
Filter by counterparty name
sign
String (yyyymmdd)
Filter by debits or credits

Responses

Status: 200 - GetTransactionsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getCardsByAccount

Retrieve all Cards for account

Method used to retrieve all Cards for specific account.


/holdings/accounts/GetCardsByAccount/{externalAccountID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/GetCardsByAccount/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardsByAccountResponse result = apiInstance.getCardsByAccount(externalAccountID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getCardsByAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardsByAccountResponse result = apiInstance.getCardsByAccount(externalAccountID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getCardsByAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

AccountApi *apiInstance = [[AccountApi alloc] init];

// Retrieve all Cards for account
[apiInstance getCardsByAccountWith:externalAccountID
    requestID:requestID
              completionHandler: ^(GetCardsByAccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardsByAccount(externalAccountID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardsByAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve all Cards for account
                GetCardsByAccountResponse result = apiInstance.getCardsByAccount(externalAccountID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getCardsByAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getCardsByAccount($externalAccountID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getCardsByAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getCardsByAccount(externalAccountID => $externalAccountID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getCardsByAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve all Cards for account
    api_response = api_instance.get_cards_by_account(externalAccountID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getCardsByAccount: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetCardsByAccountResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getDirectDebits

Retrieve all DD instuctions setup on the account

Method used to retrieve the list of direct debits setup for a specific account.


/holdings/accounts/GetDirectDebits/{externalAccountID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/GetDirectDebits/{externalAccountID}?requestID=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        try {
            GetDirectDebitsResponse result = apiInstance.getDirectDebits(externalAccountID, requestID, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getDirectDebits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        try {
            GetDirectDebitsResponse result = apiInstance.getDirectDebits(externalAccountID, requestID, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getDirectDebits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *externalAccountID = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Integer *pageNumber = 56; // The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
Integer *pageSize = 56; // The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)

AccountApi *apiInstance = [[AccountApi alloc] init];

// Retrieve all DD instuctions setup on the account
[apiInstance getDirectDebitsWith:externalAccountID
    requestID:requestID
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(GetDirectDebitsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var opts = { 
  'pageNumber': 56, // {Integer} The page number to control returned results into manageable sets. Default to 1 if not supplied.
  'pageSize': 56 // {Integer} The page size to control returned results into manageable sets. Default to 5 if not supplied.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDirectDebits(externalAccountID, requestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDirectDebitsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var pageNumber = 56;  // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional) 
            var pageSize = 56;  // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional) 

            try
            {
                // Retrieve all DD instuctions setup on the account
                GetDirectDebitsResponse result = apiInstance.getDirectDebits(externalAccountID, requestID, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getDirectDebits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
$pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.

try {
    $result = $api_instance->getDirectDebits($externalAccountID, $requestID, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getDirectDebits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $pageNumber = 56; # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
my $pageSize = 56; # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.

eval { 
    my $result = $api_instance->getDirectDebits(externalAccountID => $externalAccountID, requestID => $requestID, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getDirectDebits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
pageNumber = 56 # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
pageSize = 56 # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)

try: 
    # Retrieve all DD instuctions setup on the account
    api_response = api_instance.get_direct_debits(externalAccountID, requestID, pageNumber=pageNumber, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getDirectDebits: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required
pageNumber
Integer
The page number to control returned results into manageable sets. Default to 1 if not supplied.
pageSize
Integer
The page size to control returned results into manageable sets. Default to 5 if not supplied.

Responses

Status: 200 - GetDirectDebitsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getScheduledPayments

Retrieve all scheduled payments setup on the account

Method used to retrieve the list of scheduled payment setup for a specific account.


/holdings/accounts/GetScheduledPayments/{externalAccountID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/GetScheduledPayments/{externalAccountID}?requestID=&pageNumber=&pageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        try {
            GetScheduledPaymentsResponse result = apiInstance.getScheduledPayments(externalAccountID, requestID, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getScheduledPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID externalAccountID = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        try {
            GetScheduledPaymentsResponse result = apiInstance.getScheduledPayments(externalAccountID, requestID, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#getScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *externalAccountID = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Integer *pageNumber = 56; // The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
Integer *pageSize = 56; // The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)

AccountApi *apiInstance = [[AccountApi alloc] init];

// Retrieve all scheduled payments  setup on the account
[apiInstance getScheduledPaymentsWith:externalAccountID
    requestID:requestID
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(GetScheduledPaymentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var opts = { 
  'pageNumber': 56, // {Integer} The page number to control returned results into manageable sets. Default to 1 if not supplied.
  'pageSize': 56 // {Integer} The page size to control returned results into manageable sets. Default to 5 if not supplied.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScheduledPayments(externalAccountID, requestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScheduledPaymentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var pageNumber = 56;  // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional) 
            var pageSize = 56;  // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional) 

            try
            {
                // Retrieve all scheduled payments  setup on the account
                GetScheduledPaymentsResponse result = apiInstance.getScheduledPayments(externalAccountID, requestID, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.getScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
$pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.

try {
    $result = $api_instance->getScheduledPayments($externalAccountID, $requestID, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->getScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $pageNumber = 56; # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
my $pageSize = 56; # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.

eval { 
    my $result = $api_instance->getScheduledPayments(externalAccountID => $externalAccountID, requestID => $requestID, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->getScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
pageNumber = 56 # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
pageSize = 56 # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)

try: 
    # Retrieve all scheduled payments  setup on the account
    api_response = api_instance.get_scheduled_payments(externalAccountID, requestID, pageNumber=pageNumber, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->getScheduledPayments: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required
pageNumber
Integer
The page number to control returned results into manageable sets. Default to 1 if not supplied.
pageSize
Integer
The page size to control returned results into manageable sets. Default to 5 if not supplied.

Responses

Status: 200 - GetScheduledPaymentsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


sourceOfFunds

Set the source of funds account for a card

Method used to link a source of funds wallet to an existing Card record in Optimus Optimus Cards system. This must be called prior to any card authorisations being approved.


/holdings/accounts/SourceOfFunds/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/SourceOfFunds/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SourceOfFundsRequestBody payload = ; // SourceOfFundsRequestBody | body Payload
        try {
            SourceOfFundsResponse result = apiInstance.sourceOfFunds(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#sourceOfFunds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SourceOfFundsRequestBody payload = ; // SourceOfFundsRequestBody | body Payload
        try {
            SourceOfFundsResponse result = apiInstance.sourceOfFunds(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#sourceOfFunds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
SourceOfFundsRequestBody *payload = ; // body Payload

AccountApi *apiInstance = [[AccountApi alloc] init];

// Set the source of funds account for a card
[apiInstance sourceOfFundsWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(SourceOfFundsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {SourceOfFundsRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sourceOfFunds(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sourceOfFundsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new SourceOfFundsRequestBody(); // SourceOfFundsRequestBody | body Payload

            try
            {
                // Set the source of funds account for a card
                SourceOfFundsResponse result = apiInstance.sourceOfFunds(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.sourceOfFunds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // SourceOfFundsRequestBody | body Payload

try {
    $result = $api_instance->sourceOfFunds($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->sourceOfFunds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::SourceOfFundsRequestBody->new(); # SourceOfFundsRequestBody | body Payload

eval { 
    my $result = $api_instance->sourceOfFunds(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->sourceOfFunds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # SourceOfFundsRequestBody | body Payload

try: 
    # Set the source of funds account for a card
    api_response = api_instance.source_of_funds(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->sourceOfFunds: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - SourceOfFundsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateAccount

Update account record

Method used to update an Account record in Optimus Optimus Cards system to add/remove joint holders. No other account details can be updated.


/holdings/accounts/UpdateAccount/{externalAccountID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/accounts/UpdateAccount/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateAccountRequestBody payload = ; // UpdateAccountRequestBody | body Payload
        try {
            UpdateAccountResponse result = apiInstance.updateAccount(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#updateAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateAccountRequestBody payload = ; // UpdateAccountRequestBody | body Payload
        try {
            UpdateAccountResponse result = apiInstance.updateAccount(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#updateAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateAccountRequestBody *payload = ; // body Payload

AccountApi *apiInstance = [[AccountApi alloc] init];

// Update account record
[apiInstance updateAccountWith:externalAccountID
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateAccountResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AccountApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateAccountRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAccount(externalAccountID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccountApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateAccountRequestBody(); // UpdateAccountRequestBody | body Payload

            try
            {
                // Update account record
                UpdateAccountResponse result = apiInstance.updateAccount(externalAccountID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.updateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateAccountRequestBody | body Payload

try {
    $result = $api_instance->updateAccount($externalAccountID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->updateAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateAccountRequestBody->new(); # UpdateAccountRequestBody | body Payload

eval { 
    my $result = $api_instance->updateAccount(externalAccountID => $externalAccountID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->updateAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateAccountRequestBody | body Payload

try: 
    # Update account record
    api_response = api_instance.update_account(externalAccountID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->updateAccount: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateAccountResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Administrative

ping

Pings the service

Method used to setup monitors and determine availability for Optimus Cards rest services.


/admin/ping

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/admin/ping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdministrativeApi;

import java.io.File;
import java.util.*;

public class AdministrativeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AdministrativeApi apiInstance = new AdministrativeApi();
        try {
            pingResponse result = apiInstance.ping();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrativeApi#ping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdministrativeApi;

public class AdministrativeApiExample {

    public static void main(String[] args) {
        AdministrativeApi apiInstance = new AdministrativeApi();
        try {
            pingResponse result = apiInstance.ping();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdministrativeApi#ping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


AdministrativeApi *apiInstance = [[AdministrativeApi alloc] init];

// Pings the service
[apiInstance pingWithCompletionHandler: 
              ^(pingResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.AdministrativeApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.ping(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pingExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AdministrativeApi();

            try
            {
                // Pings the service
                pingResponse result = apiInstance.ping();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdministrativeApi.ping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\AdministrativeApi();

try {
    $result = $api_instance->ping();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrativeApi->ping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdministrativeApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdministrativeApi->new();

eval { 
    my $result = $api_instance->ping();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdministrativeApi->ping: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AdministrativeApi()

try: 
    # Pings the service
    api_response = api_instance.ping()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrativeApi->ping: %s\n" % e)

Parameters

Responses

Status: 200 - pingResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Balance

balanceUpdate

Account balance update

Method used to update the STIP balance of an account.


/orders/transactions/BalanceUpdate/{externalAccountID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/orders/transactions/BalanceUpdate/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BalanceApi;

import java.io.File;
import java.util.*;

public class BalanceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        BalanceApi apiInstance = new BalanceApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        BalanceUpdateRequestBody payload = ; // BalanceUpdateRequestBody | body Payload
        try {
            BalanceUpdateResponse result = apiInstance.balanceUpdate(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalanceApi#balanceUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BalanceApi;

public class BalanceApiExample {

    public static void main(String[] args) {
        BalanceApi apiInstance = new BalanceApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        BalanceUpdateRequestBody payload = ; // BalanceUpdateRequestBody | body Payload
        try {
            BalanceUpdateResponse result = apiInstance.balanceUpdate(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalanceApi#balanceUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
BalanceUpdateRequestBody *payload = ; // body Payload

BalanceApi *apiInstance = [[BalanceApi alloc] init];

// Account balance update
[apiInstance balanceUpdateWith:externalAccountID
    requestID:requestID
    payload:payload
              completionHandler: ^(BalanceUpdateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.BalanceApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {BalanceUpdateRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.balanceUpdate(externalAccountID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class balanceUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BalanceApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new BalanceUpdateRequestBody(); // BalanceUpdateRequestBody | body Payload

            try
            {
                // Account balance update
                BalanceUpdateResponse result = apiInstance.balanceUpdate(externalAccountID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BalanceApi.balanceUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BalanceApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // BalanceUpdateRequestBody | body Payload

try {
    $result = $api_instance->balanceUpdate($externalAccountID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalanceApi->balanceUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalanceApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BalanceApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::BalanceUpdateRequestBody->new(); # BalanceUpdateRequestBody | body Payload

eval { 
    my $result = $api_instance->balanceUpdate(externalAccountID => $externalAccountID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BalanceApi->balanceUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BalanceApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # BalanceUpdateRequestBody | body Payload

try: 
    # Account balance update
    api_response = api_instance.balance_update(externalAccountID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->balanceUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - CreateAccountResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Banks

getBanks

Retrieve all banks participating in Open Banking

Method used to retrieve all banks participating in Open Banking.


/party/banks/GetBanks

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/banks/GetBanks?requestID=&country="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BanksApi;

import java.io.File;
import java.util.*;

public class BanksApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        BanksApi apiInstance = new BanksApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        String country = country_example; // String | 
        try {
            GetBanksResponse result = apiInstance.getBanks(requestID, country);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BanksApi#getBanks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BanksApi;

public class BanksApiExample {

    public static void main(String[] args) {
        BanksApi apiInstance = new BanksApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        String country = country_example; // String | 
        try {
            GetBanksResponse result = apiInstance.getBanks(requestID, country);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BanksApi#getBanks");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
String *country = country_example; //  (optional)

BanksApi *apiInstance = [[BanksApi alloc] init];

// Retrieve all banks participating in Open Banking
[apiInstance getBanksWith:requestID
    country:country
              completionHandler: ^(GetBanksResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.BanksApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var opts = { 
  'country': country_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBanks(requestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBanksExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BanksApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var country = country_example;  // String |  (optional) 

            try
            {
                // Retrieve all banks participating in Open Banking
                GetBanksResponse result = apiInstance.getBanks(requestID, country);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BanksApi.getBanks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\BanksApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$country = country_example; // String | 

try {
    $result = $api_instance->getBanks($requestID, $country);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BanksApi->getBanks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BanksApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BanksApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $country = country_example; # String | 

eval { 
    my $result = $api_instance->getBanks(requestID => $requestID, country => $country);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BanksApi->getBanks: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BanksApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
country = country_example # String |  (optional)

try: 
    # Retrieve all banks participating in Open Banking
    api_response = api_instance.get_banks(requestID, country=country)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BanksApi->getBanks: %s\n" % e)

Parameters

Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required
country
String (alpha)

Responses

Status: 200 - GetBanksResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Card

activateCard

Activate a new plastic

Method used to activate specified card plastic.


/holdings/cards/ActivateCard/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/ActivateCard/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            OrderCardResponse result = apiInstance.activateCard(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#activateCard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            OrderCardResponse result = apiInstance.activateCard(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#activateCard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CardApi *apiInstance = [[CardApi alloc] init];

// Activate a new plastic
[apiInstance activateCardWith:cardToken
    requestID:requestID
              completionHandler: ^(OrderCardResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateCard(cardToken, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class activateCardExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Activate a new plastic
                OrderCardResponse result = apiInstance.activateCard(cardToken, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.activateCard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->activateCard($cardToken, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->activateCard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->activateCard(cardToken => $cardToken, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->activateCard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Activate a new plastic
    api_response = api_instance.activate_card(cardToken, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->activateCard: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - ActivateCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getApplePayTokenizeData

Retrieve tokenization data (IIDD) for Apple Pay push provisioning.

Method used to retrieve the data required for Apple Pay push provisioning.


/holdings/cards/GetApplePayTokenizeData/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetApplePayTokenizeData/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetApplePayTokenizeDataRequestBody payload = ; // GetApplePayTokenizeDataRequestBody | body Payload
        try {
            GetApplePayTokenizeDataResponse result = apiInstance.getApplePayTokenizeData(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getApplePayTokenizeData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetApplePayTokenizeDataRequestBody payload = ; // GetApplePayTokenizeDataRequestBody | body Payload
        try {
            GetApplePayTokenizeDataResponse result = apiInstance.getApplePayTokenizeData(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getApplePayTokenizeData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
GetApplePayTokenizeDataRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve tokenization data (IIDD) for Apple Pay push provisioning.
[apiInstance getApplePayTokenizeDataWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(GetApplePayTokenizeDataResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {GetApplePayTokenizeDataRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplePayTokenizeData(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplePayTokenizeDataExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new GetApplePayTokenizeDataRequestBody(); // GetApplePayTokenizeDataRequestBody | body Payload

            try
            {
                // Retrieve tokenization data (IIDD) for Apple Pay push provisioning.
                GetApplePayTokenizeDataResponse result = apiInstance.getApplePayTokenizeData(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getApplePayTokenizeData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // GetApplePayTokenizeDataRequestBody | body Payload

try {
    $result = $api_instance->getApplePayTokenizeData($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getApplePayTokenizeData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::GetApplePayTokenizeDataRequestBody->new(); # GetApplePayTokenizeDataRequestBody | body Payload

eval { 
    my $result = $api_instance->getApplePayTokenizeData(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getApplePayTokenizeData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # GetApplePayTokenizeDataRequestBody | body Payload

try: 
    # Retrieve tokenization data (IIDD) for Apple Pay push provisioning.
    api_response = api_instance.get_apple_pay_tokenize_data(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getApplePayTokenizeData: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - OrderCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getCVCEncrypted

Retrieve card CVC

Method used to retrieve CVC in encrypted format.


/holdings/cards/GetCVCEncrypted/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetCVCEncrypted/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetCVCEncryptedRequestBody payload = ; // GetCVCEncryptedRequestBody | body Payload
        try {
            GetCVCEncryptedResponse result = apiInstance.getCVCEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCVCEncrypted");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetCVCEncryptedRequestBody payload = ; // GetCVCEncryptedRequestBody | body Payload
        try {
            GetCVCEncryptedResponse result = apiInstance.getCVCEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCVCEncrypted");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
GetCVCEncryptedRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve card CVC
[apiInstance getCVCEncryptedWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(GetCVCEncryptedResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {GetCVCEncryptedRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCVCEncrypted(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCVCEncryptedExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new GetCVCEncryptedRequestBody(); // GetCVCEncryptedRequestBody | body Payload

            try
            {
                // Retrieve card CVC
                GetCVCEncryptedResponse result = apiInstance.getCVCEncrypted(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getCVCEncrypted: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // GetCVCEncryptedRequestBody | body Payload

try {
    $result = $api_instance->getCVCEncrypted($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getCVCEncrypted: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::GetCVCEncryptedRequestBody->new(); # GetCVCEncryptedRequestBody | body Payload

eval { 
    my $result = $api_instance->getCVCEncrypted(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getCVCEncrypted: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # GetCVCEncryptedRequestBody | body Payload

try: 
    # Retrieve card CVC
    api_response = api_instance.get_cvc_encrypted(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getCVCEncrypted: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetCVCEncryptedResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getCardDetails

Retrieve card details

Method used to retrieve current information held in Optimus CMS about specific Card.


/holdings/cards/GetCardDetails/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetCardDetails/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardDetailsResponse result = apiInstance.getCardDetails(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCardDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardDetailsResponse result = apiInstance.getCardDetails(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCardDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve card details
[apiInstance getCardDetailsWith:cardToken
    requestID:requestID
              completionHandler: ^(GetCardDetailsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardDetails(cardToken, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardDetailsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve card details
                GetCardDetailsResponse result = apiInstance.getCardDetails(cardToken, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getCardDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getCardDetails($cardToken, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getCardDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getCardDetails(cardToken => $cardToken, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getCardDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve card details
    api_response = api_instance.get_card_details(cardToken, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getCardDetails: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - OrderCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getCardStatus

Retrieve card status

Method used to retrieve current status of a specific Card.


/holdings/cards/GetCardStatus/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetCardStatus/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardStatusResponse result = apiInstance.getCardStatus(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCardStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardStatusResponse result = apiInstance.getCardStatus(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCardStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve card status
[apiInstance getCardStatusWith:cardToken
    requestID:requestID
              completionHandler: ^(GetCardStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardStatus(cardToken, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardStatusExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve card status
                GetCardStatusResponse result = apiInstance.getCardStatus(cardToken, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getCardStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getCardStatus($cardToken, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getCardStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getCardStatus(cardToken => $cardToken, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getCardStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve card status
    api_response = api_instance.get_card_status(cardToken, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getCardStatus: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetCardStatusResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getCardTransactions

Retrieve card transactions

Method used to retrieve transaction history for a specific card.


/holdings/cards/GetTransactions/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetTransactions/{cardToken}?requestID=&pageNumber=&pageSize=&startDate=&endDate=&amountFrom=&amountTo=&counterparty=&sign="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        String startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
        String endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
        BigDecimal amountFrom = 8.14; // BigDecimal | Filter by amounts greater than or equal to given value
        Integer amountTo = 56; // Integer | Filter by amounts less than or equal to given value
        String counterparty = counterparty_example; // String | Filter by counterparty name
        String sign = sign_example; // String | Filter by debits or credits
        try {
            GetTransactionsResponse result = apiInstance.getCardTransactions(cardToken, requestID, pageNumber, pageSize, startDate, endDate, amountFrom, amountTo, counterparty, sign);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCardTransactions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        Integer pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
        Integer pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
        String startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
        String endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
        BigDecimal amountFrom = 8.14; // BigDecimal | Filter by amounts greater than or equal to given value
        Integer amountTo = 56; // Integer | Filter by amounts less than or equal to given value
        String counterparty = counterparty_example; // String | Filter by counterparty name
        String sign = sign_example; // String | Filter by debits or credits
        try {
            GetTransactionsResponse result = apiInstance.getCardTransactions(cardToken, requestID, pageNumber, pageSize, startDate, endDate, amountFrom, amountTo, counterparty, sign);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getCardTransactions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Integer *pageNumber = 56; // The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
Integer *pageSize = 56; // The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)
String *startDate = startDate_example; // The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional)
String *endDate = endDate_example; // The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional)
BigDecimal *amountFrom = 8.14; // Filter by amounts greater than or equal to given value (optional)
Integer *amountTo = 56; // Filter by amounts less than or equal to given value (optional)
String *counterparty = counterparty_example; // Filter by counterparty name (optional)
String *sign = sign_example; // Filter by debits or credits (optional)

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve card transactions
[apiInstance getCardTransactionsWith:cardToken
    requestID:requestID
    pageNumber:pageNumber
    pageSize:pageSize
    startDate:startDate
    endDate:endDate
    amountFrom:amountFrom
    amountTo:amountTo
    counterparty:counterparty
    sign:sign
              completionHandler: ^(GetTransactionsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var opts = { 
  'pageNumber': 56, // {Integer} The page number to control returned results into manageable sets. Default to 1 if not supplied.
  'pageSize': 56, // {Integer} The page size to control returned results into manageable sets. Default to 5 if not supplied.
  'startDate': startDate_example, // {String} The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
  'endDate': endDate_example, // {String} The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
  'amountFrom': 8.14, // {BigDecimal} Filter by amounts greater than or equal to given value
  'amountTo': 56, // {Integer} Filter by amounts less than or equal to given value
  'counterparty': counterparty_example, // {String} Filter by counterparty name
  'sign': sign_example // {String} Filter by debits or credits
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardTransactions(cardToken, requestID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardTransactionsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var pageNumber = 56;  // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional) 
            var pageSize = 56;  // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional) 
            var startDate = startDate_example;  // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional) 
            var endDate = endDate_example;  // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional) 
            var amountFrom = 8.14;  // BigDecimal | Filter by amounts greater than or equal to given value (optional) 
            var amountTo = 56;  // Integer | Filter by amounts less than or equal to given value (optional) 
            var counterparty = counterparty_example;  // String | Filter by counterparty name (optional) 
            var sign = sign_example;  // String | Filter by debits or credits (optional) 

            try
            {
                // Retrieve card transactions
                GetTransactionsResponse result = apiInstance.getCardTransactions(cardToken, requestID, pageNumber, pageSize, startDate, endDate, amountFrom, amountTo, counterparty, sign);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getCardTransactions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$pageNumber = 56; // Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
$pageSize = 56; // Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
$startDate = startDate_example; // String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
$endDate = endDate_example; // String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
$amountFrom = 8.14; // BigDecimal | Filter by amounts greater than or equal to given value
$amountTo = 56; // Integer | Filter by amounts less than or equal to given value
$counterparty = counterparty_example; // String | Filter by counterparty name
$sign = sign_example; // String | Filter by debits or credits

try {
    $result = $api_instance->getCardTransactions($cardToken, $requestID, $pageNumber, $pageSize, $startDate, $endDate, $amountFrom, $amountTo, $counterparty, $sign);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getCardTransactions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $pageNumber = 56; # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied.
my $pageSize = 56; # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied.
my $startDate = startDate_example; # String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
my $endDate = endDate_example; # String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
my $amountFrom = 8.14; # BigDecimal | Filter by amounts greater than or equal to given value
my $amountTo = 56; # Integer | Filter by amounts less than or equal to given value
my $counterparty = counterparty_example; # String | Filter by counterparty name
my $sign = sign_example; # String | Filter by debits or credits

eval { 
    my $result = $api_instance->getCardTransactions(cardToken => $cardToken, requestID => $requestID, pageNumber => $pageNumber, pageSize => $pageSize, startDate => $startDate, endDate => $endDate, amountFrom => $amountFrom, amountTo => $amountTo, counterparty => $counterparty, sign => $sign);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getCardTransactions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
pageNumber = 56 # Integer | The page number to control returned results into manageable sets. Default to 1 if not supplied. (optional)
pageSize = 56 # Integer | The page size to control returned results into manageable sets. Default to 5 if not supplied. (optional)
startDate = startDate_example # String | The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied. (optional)
endDate = endDate_example # String | The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied. (optional)
amountFrom = 8.14 # BigDecimal | Filter by amounts greater than or equal to given value (optional)
amountTo = 56 # Integer | Filter by amounts less than or equal to given value (optional)
counterparty = counterparty_example # String | Filter by counterparty name (optional)
sign = sign_example # String | Filter by debits or credits (optional)

try: 
    # Retrieve card transactions
    api_response = api_instance.get_card_transactions(cardToken, requestID, pageNumber=pageNumber, pageSize=pageSize, startDate=startDate, endDate=endDate, amountFrom=amountFrom, amountTo=amountTo, counterparty=counterparty, sign=sign)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getCardTransactions: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required
pageNumber
Integer
The page number to control returned results into manageable sets. Default to 1 if not supplied.
pageSize
Integer
The page size to control returned results into manageable sets. Default to 5 if not supplied.
startDate
String (yyyymmdd)
The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified. Default to today's date if not supplied.
endDate
String (yyyymmdd)
The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified. Default to today's date if not supplied.
amountFrom
BigDecimal
Filter by amounts greater than or equal to given value
amountTo
Integer
Filter by amounts less than or equal to given value
counterparty
String (yyyymmdd)
Filter by counterparty name
sign
String (yyyymmdd)
Filter by debits or credits

Responses

Status: 200 - GetTransactionsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getGooglePayTokenizeData

Retrieve OPC (IIDD) for Google Pay tokenization.

Method used to retrieve the OPC required for Google Pay push provisioning.


/holdings/cards/GetGooglePayTokenizeData/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetGooglePayTokenizeData/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetGooglePayTokenizeDataRequestBody payload = ; // GetGooglePayTokenizeDataRequestBody | body Payload
        try {
            GetGooglePayTokenizeDataResponse result = apiInstance.getGooglePayTokenizeData(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getGooglePayTokenizeData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetGooglePayTokenizeDataRequestBody payload = ; // GetGooglePayTokenizeDataRequestBody | body Payload
        try {
            GetGooglePayTokenizeDataResponse result = apiInstance.getGooglePayTokenizeData(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getGooglePayTokenizeData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
GetGooglePayTokenizeDataRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve OPC (IIDD) for Google Pay tokenization.
[apiInstance getGooglePayTokenizeDataWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(GetGooglePayTokenizeDataResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {GetGooglePayTokenizeDataRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGooglePayTokenizeData(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGooglePayTokenizeDataExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new GetGooglePayTokenizeDataRequestBody(); // GetGooglePayTokenizeDataRequestBody | body Payload

            try
            {
                // Retrieve OPC (IIDD) for Google Pay tokenization.
                GetGooglePayTokenizeDataResponse result = apiInstance.getGooglePayTokenizeData(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getGooglePayTokenizeData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // GetGooglePayTokenizeDataRequestBody | body Payload

try {
    $result = $api_instance->getGooglePayTokenizeData($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getGooglePayTokenizeData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::GetGooglePayTokenizeDataRequestBody->new(); # GetGooglePayTokenizeDataRequestBody | body Payload

eval { 
    my $result = $api_instance->getGooglePayTokenizeData(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getGooglePayTokenizeData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # GetGooglePayTokenizeDataRequestBody | body Payload

try: 
    # Retrieve OPC (IIDD) for Google Pay tokenization.
    api_response = api_instance.get_google_pay_tokenize_data(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getGooglePayTokenizeData: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - OrderCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getPANEncrypted

Retrieve card PAN

Method used to retrieve full PAN in encrypted format.


/holdings/cards/GetPANEncrypted/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetPANEncrypted/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetPANEncryptedRequestBody payload = ; // GetPANEncryptedRequestBody | body Payload
        try {
            GetPANEncryptedResponse result = apiInstance.getPANEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getPANEncrypted");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetPANEncryptedRequestBody payload = ; // GetPANEncryptedRequestBody | body Payload
        try {
            GetPANEncryptedResponse result = apiInstance.getPANEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getPANEncrypted");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
GetPANEncryptedRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve card PAN
[apiInstance getPANEncryptedWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(GetPANEncryptedResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {GetPANEncryptedRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPANEncrypted(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPANEncryptedExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new GetPANEncryptedRequestBody(); // GetPANEncryptedRequestBody | body Payload

            try
            {
                // Retrieve card PAN
                GetPANEncryptedResponse result = apiInstance.getPANEncrypted(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getPANEncrypted: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // GetPANEncryptedRequestBody | body Payload

try {
    $result = $api_instance->getPANEncrypted($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getPANEncrypted: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::GetPANEncryptedRequestBody->new(); # GetPANEncryptedRequestBody | body Payload

eval { 
    my $result = $api_instance->getPANEncrypted(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getPANEncrypted: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # GetPANEncryptedRequestBody | body Payload

try: 
    # Retrieve card PAN
    api_response = api_instance.get_pan_encrypted(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getPANEncrypted: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetPANEncryptedResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getPINEncrypted

Retrieve card PIN

Method used to retrieve card PIN in encrypted format.


/holdings/cards/GetPINEncrypted/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetPINEncrypted/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetPINEncryptedRequestBody payload = ; // GetPINEncryptedRequestBody | body Payload
        try {
            GetPINEncryptedResponse result = apiInstance.getPINEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getPINEncrypted");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetPINEncryptedRequestBody payload = ; // GetPINEncryptedRequestBody | body Payload
        try {
            GetPINEncryptedResponse result = apiInstance.getPINEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getPINEncrypted");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
GetPINEncryptedRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve card PIN
[apiInstance getPINEncryptedWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(GetPINEncryptedResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {GetPINEncryptedRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPINEncrypted(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPINEncryptedExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new GetPINEncryptedRequestBody(); // GetPINEncryptedRequestBody | body Payload

            try
            {
                // Retrieve card PIN
                GetPINEncryptedResponse result = apiInstance.getPINEncrypted(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getPINEncrypted: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // GetPINEncryptedRequestBody | body Payload

try {
    $result = $api_instance->getPINEncrypted($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getPINEncrypted: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::GetPINEncryptedRequestBody->new(); # GetPINEncryptedRequestBody | body Payload

eval { 
    my $result = $api_instance->getPINEncrypted(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getPINEncrypted: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # GetPINEncryptedRequestBody | body Payload

try: 
    # Retrieve card PIN
    api_response = api_instance.get_pin_encrypted(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getPINEncrypted: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetPANEncryptedResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getPINImage

Retrieve token for card PIN image

Method used to retrieve a token to a hosted card PIN image.


/holdings/cards/GetPINImage/{cardToken}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/GetPINImage/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetPINImageResponse result = apiInstance.getPINImage(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getPINImage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetPINImageResponse result = apiInstance.getPINImage(cardToken, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#getPINImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CardApi *apiInstance = [[CardApi alloc] init];

// Retrieve token for card PIN image
[apiInstance getPINImageWith:cardToken
    requestID:requestID
              completionHandler: ^(GetPINImageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPINImage(cardToken, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPINImageExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve token for card PIN image
                GetPINImageResponse result = apiInstance.getPINImage(cardToken, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.getPINImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getPINImage($cardToken, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->getPINImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getPINImage(cardToken => $cardToken, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->getPINImage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve token for card PIN image
    api_response = api_instance.get_pin_image(cardToken, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->getPINImage: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetPINImageResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


orderCard

New card record

Method used to create a Card order record in Optimus Optimus Cards system.


/holdings/cards/OrderCard

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/OrderCard?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        OrderCardRequestBody payload = ; // OrderCardRequestBody | body Payload
        try {
            OrderCardResponse result = apiInstance.orderCard(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#orderCard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        OrderCardRequestBody payload = ; // OrderCardRequestBody | body Payload
        try {
            OrderCardResponse result = apiInstance.orderCard(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#orderCard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
OrderCardRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// New card record
[apiInstance orderCardWith:requestID
    payload:payload
              completionHandler: ^(OrderCardResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {OrderCardRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.orderCard(requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class orderCardExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new OrderCardRequestBody(); // OrderCardRequestBody | body Payload

            try
            {
                // New card record
                OrderCardResponse result = apiInstance.orderCard(requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.orderCard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // OrderCardRequestBody | body Payload

try {
    $result = $api_instance->orderCard($requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->orderCard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::OrderCardRequestBody->new(); # OrderCardRequestBody | body Payload

eval { 
    my $result = $api_instance->orderCard(requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->orderCard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # OrderCardRequestBody | body Payload

try: 
    # New card record
    api_response = api_instance.order_card(requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->orderCard: %s\n" % e)

Parameters

Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - OrderCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


orderCardNewMember

New customer and card records

Method used to create a Customer record in Optimus Optimus Cards system and order a new Card for them. For this method, a mirror account is opened in the card default currency.


/holdings/cards/OrderCardNewMember

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/OrderCardNewMember?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        OrderCardNewMemberRequestBody payload = ; // OrderCardNewMemberRequestBody | body Payload
        try {
            OrderCardNewMemberResponse result = apiInstance.orderCardNewMember(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#orderCardNewMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        OrderCardNewMemberRequestBody payload = ; // OrderCardNewMemberRequestBody | body Payload
        try {
            OrderCardNewMemberResponse result = apiInstance.orderCardNewMember(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#orderCardNewMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
OrderCardNewMemberRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// New customer and card records
[apiInstance orderCardNewMemberWith:requestID
    payload:payload
              completionHandler: ^(OrderCardNewMemberResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {OrderCardNewMemberRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.orderCardNewMember(requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class orderCardNewMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new OrderCardNewMemberRequestBody(); // OrderCardNewMemberRequestBody | body Payload

            try
            {
                // New customer and card records
                OrderCardNewMemberResponse result = apiInstance.orderCardNewMember(requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.orderCardNewMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // OrderCardNewMemberRequestBody | body Payload

try {
    $result = $api_instance->orderCardNewMember($requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->orderCardNewMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::OrderCardNewMemberRequestBody->new(); # OrderCardNewMemberRequestBody | body Payload

eval { 
    my $result = $api_instance->orderCardNewMember(requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->orderCardNewMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # OrderCardNewMemberRequestBody | body Payload

try: 
    # New customer and card records
    api_response = api_instance.order_card_new_member(requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->orderCardNewMember: %s\n" % e)

Parameters

Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - OrderCardNewMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


orderVirtualCard

New virtual card record

Method used to create a virtual Card order record in Optimus Optimus Cards system.


/holdings/cards/OrderVirtualCard

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/OrderVirtualCard?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        OrderCardRequestBody payload = ; // OrderCardRequestBody | body Payload
        try {
            OrderCardResponse result = apiInstance.orderVirtualCard(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#orderVirtualCard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        OrderCardRequestBody payload = ; // OrderCardRequestBody | body Payload
        try {
            OrderCardResponse result = apiInstance.orderVirtualCard(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#orderVirtualCard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
OrderCardRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// New virtual card record
[apiInstance orderVirtualCardWith:requestID
    payload:payload
              completionHandler: ^(OrderCardResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {OrderCardRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.orderVirtualCard(requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class orderVirtualCardExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new OrderCardRequestBody(); // OrderCardRequestBody | body Payload

            try
            {
                // New virtual card record
                OrderCardResponse result = apiInstance.orderVirtualCard(requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.orderVirtualCard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // OrderCardRequestBody | body Payload

try {
    $result = $api_instance->orderVirtualCard($requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->orderVirtualCard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::OrderCardRequestBody->new(); # OrderCardRequestBody | body Payload

eval { 
    my $result = $api_instance->orderVirtualCard(requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->orderVirtualCard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # OrderCardRequestBody | body Payload

try: 
    # New virtual card record
    api_response = api_instance.order_virtual_card(requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->orderVirtualCard: %s\n" % e)

Parameters

Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - OrderCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


reissueCard

Reissue a new plastic

Method used to reissue card i.e. order a new Card Plastic. A replacement type has to be indicated.


/holdings/cards/ReissueCard/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/ReissueCard/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        ReissueCardRequestBody payload = ; // ReissueCardRequestBody | body Payload
        try {
            ReissueCardResponse result = apiInstance.reissueCard(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#reissueCard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        ReissueCardRequestBody payload = ; // ReissueCardRequestBody | body Payload
        try {
            ReissueCardResponse result = apiInstance.reissueCard(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#reissueCard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
ReissueCardRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Reissue a new plastic
[apiInstance reissueCardWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(ReissueCardResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {ReissueCardRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reissueCard(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reissueCardExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new ReissueCardRequestBody(); // ReissueCardRequestBody | body Payload

            try
            {
                // Reissue a new plastic
                ReissueCardResponse result = apiInstance.reissueCard(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.reissueCard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // ReissueCardRequestBody | body Payload

try {
    $result = $api_instance->reissueCard($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->reissueCard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::ReissueCardRequestBody->new(); # ReissueCardRequestBody | body Payload

eval { 
    my $result = $api_instance->reissueCard(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->reissueCard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # ReissueCardRequestBody | body Payload

try: 
    # Reissue a new plastic
    api_response = api_instance.reissue_card(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->reissueCard: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - ReissueCardResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


setPINEncrypted

Set or change PIN

Method sets a new PIN for the card. Old PIN verification is not required. PIN block is encrypted with public key reseived in response of getPublicRSAKey.


/holdings/cards/SetPINEncrypted/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/SetPINEncrypted/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SetPINEncryptedRequestBody payload = ; // SetPINEncryptedRequestBody | body Payload
        try {
            SetPINEncryptedResponse result = apiInstance.setPINEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#setPINEncrypted");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SetPINEncryptedRequestBody payload = ; // SetPINEncryptedRequestBody | body Payload
        try {
            SetPINEncryptedResponse result = apiInstance.setPINEncrypted(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#setPINEncrypted");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
SetPINEncryptedRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Set or change PIN
[apiInstance setPINEncryptedWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(SetPINEncryptedResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {SetPINEncryptedRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPINEncrypted(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setPINEncryptedExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new SetPINEncryptedRequestBody(); // SetPINEncryptedRequestBody | body Payload

            try
            {
                // Set or change PIN
                SetPINEncryptedResponse result = apiInstance.setPINEncrypted(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.setPINEncrypted: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // SetPINEncryptedRequestBody | body Payload

try {
    $result = $api_instance->setPINEncrypted($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->setPINEncrypted: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::SetPINEncryptedRequestBody->new(); # SetPINEncryptedRequestBody | body Payload

eval { 
    my $result = $api_instance->setPINEncrypted(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->setPINEncrypted: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # SetPINEncryptedRequestBody | body Payload

try: 
    # Set or change PIN
    api_response = api_instance.set_pin_encrypted(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->setPINEncrypted: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateCardContactlessResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateCardContactless

Disable / Enable contactless interface

Method used to disable or enable the contactless interface for a specified plastic.


/holdings/cards/UpdateCardContactless/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/UpdateCardContactless/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateCardContactlessRequestBody payload = ; // UpdateCardContactlessRequestBody | body Payload
        try {
            UpdateCardContactlessResponse result = apiInstance.updateCardContactless(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#updateCardContactless");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateCardContactlessRequestBody payload = ; // UpdateCardContactlessRequestBody | body Payload
        try {
            UpdateCardContactlessResponse result = apiInstance.updateCardContactless(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#updateCardContactless");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateCardContactlessRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Disable / Enable contactless interface
[apiInstance updateCardContactlessWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateCardContactlessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateCardContactlessRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCardContactless(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCardContactlessExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateCardContactlessRequestBody(); // UpdateCardContactlessRequestBody | body Payload

            try
            {
                // Disable / Enable contactless interface
                UpdateCardContactlessResponse result = apiInstance.updateCardContactless(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.updateCardContactless: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateCardContactlessRequestBody | body Payload

try {
    $result = $api_instance->updateCardContactless($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->updateCardContactless: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateCardContactlessRequestBody->new(); # UpdateCardContactlessRequestBody | body Payload

eval { 
    my $result = $api_instance->updateCardContactless(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->updateCardContactless: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateCardContactlessRequestBody | body Payload

try: 
    # Disable / Enable contactless interface
    api_response = api_instance.update_card_contactless(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->updateCardContactless: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateCardContactlessResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateCardStatus

Change the status of a card plastic

Method used to change the status of a specified card plastic.


/holdings/cards/UpdateCardStatus/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/UpdateCardStatus/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateCardStatusRequestBody payload = ; // UpdateCardStatusRequestBody | body Payload
        try {
            UpdateCardStatusResponse result = apiInstance.updateCardStatus(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#updateCardStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateCardStatusRequestBody payload = ; // UpdateCardStatusRequestBody | body Payload
        try {
            UpdateCardStatusResponse result = apiInstance.updateCardStatus(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#updateCardStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateCardStatusRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Change the status of a card plastic
[apiInstance updateCardStatusWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateCardStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateCardStatusRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCardStatus(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCardStatusExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateCardStatusRequestBody(); // UpdateCardStatusRequestBody | body Payload

            try
            {
                // Change the status of a card plastic
                UpdateCardStatusResponse result = apiInstance.updateCardStatus(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.updateCardStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateCardStatusRequestBody | body Payload

try {
    $result = $api_instance->updateCardStatus($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->updateCardStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateCardStatusRequestBody->new(); # UpdateCardStatusRequestBody | body Payload

eval { 
    my $result = $api_instance->updateCardStatus(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->updateCardStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateCardStatusRequestBody | body Payload

try: 
    # Change the status of a card plastic
    api_response = api_instance.update_card_status(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->updateCardStatus: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateCardStatusResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateCardUsageLimits

Update card usage limits

Method used to set/change card usage limits.


/holdings/cards/UpdateCardUsageLimits/{cardToken}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/holdings/cards/UpdateCardUsageLimits/{cardToken}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardApi;

import java.io.File;
import java.util.*;

public class CardApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateCardUsageLimitsRequestBody payload = ; // UpdateCardUsageLimitsRequestBody | body Payload
        try {
            UpdateCardUsageLimitsResponse result = apiInstance.updateCardUsageLimits(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#updateCardUsageLimits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CardApi;

public class CardApiExample {

    public static void main(String[] args) {
        CardApi apiInstance = new CardApi();
        UUID cardToken = ; // UUID | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateCardUsageLimitsRequestBody payload = ; // UpdateCardUsageLimitsRequestBody | body Payload
        try {
            UpdateCardUsageLimitsResponse result = apiInstance.updateCardUsageLimits(cardToken, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardApi#updateCardUsageLimits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UUID *cardToken = ; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateCardUsageLimitsRequestBody *payload = ; // body Payload

CardApi *apiInstance = [[CardApi alloc] init];

// Update card usage limits
[apiInstance updateCardUsageLimitsWith:cardToken
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateCardUsageLimitsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CardApi()

var cardToken = ; // {UUID} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateCardUsageLimitsRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCardUsageLimits(cardToken, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCardUsageLimitsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CardApi();
            var cardToken = new UUID(); // UUID | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateCardUsageLimitsRequestBody(); // UpdateCardUsageLimitsRequestBody | body Payload

            try
            {
                // Update card usage limits
                UpdateCardUsageLimitsResponse result = apiInstance.updateCardUsageLimits(cardToken, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardApi.updateCardUsageLimits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CardApi();
$cardToken = ; // UUID | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateCardUsageLimitsRequestBody | body Payload

try {
    $result = $api_instance->updateCardUsageLimits($cardToken, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardApi->updateCardUsageLimits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CardApi->new();
my $cardToken = ; # UUID | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateCardUsageLimitsRequestBody->new(); # UpdateCardUsageLimitsRequestBody | body Payload

eval { 
    my $result = $api_instance->updateCardUsageLimits(cardToken => $cardToken, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardApi->updateCardUsageLimits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CardApi()
cardToken =  # UUID | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateCardUsageLimitsRequestBody | body Payload

try: 
    # Update card usage limits
    api_response = api_instance.update_card_usage_limits(cardToken, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardApi->updateCardUsageLimits: %s\n" % e)

Parameters

Path parameters
Name Description
cardToken*
UUID (uuid)
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateCardContactlessResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Customer

createBeneficiary

Used to create a new Recipient for an existing Customer.


/party/customers/CreateBeneficiary/{externalCustomerID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/CreateBeneficiary/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer.
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateBeneficiaryRequestBody payload = ; // CreateBeneficiaryRequestBody | body Payload
        try {
            CreateBeneficiaryResponse result = apiInstance.createBeneficiary(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#createBeneficiary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer.
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateBeneficiaryRequestBody payload = ; // CreateBeneficiaryRequestBody | body Payload
        try {
            CreateBeneficiaryResponse result = apiInstance.createBeneficiary(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#createBeneficiary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // Unique identifier from the partner`s system for the Customer.
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
CreateBeneficiaryRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Used to create a new Recipient for an existing Customer.
[apiInstance createBeneficiaryWith:externalCustomerID
    requestID:requestID
    payload:payload
              completionHandler: ^(CreateBeneficiaryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} Unique identifier from the partner`s system for the Customer.

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {CreateBeneficiaryRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createBeneficiary(externalCustomerID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createBeneficiaryExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | Unique identifier from the partner`s system for the Customer.
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new CreateBeneficiaryRequestBody(); // CreateBeneficiaryRequestBody | body Payload

            try
            {
                // Used to create a new Recipient for an existing Customer.
                CreateBeneficiaryResponse result = apiInstance.createBeneficiary(externalCustomerID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.createBeneficiary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer.
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // CreateBeneficiaryRequestBody | body Payload

try {
    $result = $api_instance->createBeneficiary($externalCustomerID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->createBeneficiary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | Unique identifier from the partner`s system for the Customer.
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::CreateBeneficiaryRequestBody->new(); # CreateBeneficiaryRequestBody | body Payload

eval { 
    my $result = $api_instance->createBeneficiary(externalCustomerID => $externalCustomerID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->createBeneficiary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | Unique identifier from the partner`s system for the Customer.
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # CreateBeneficiaryRequestBody | body Payload

try: 
    # Used to create a new Recipient for an existing Customer.
    api_response = api_instance.create_beneficiary(externalCustomerID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->createBeneficiary: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Unique identifier from the partner`s system for the Customer.
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - CreateBeneficiaryResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


createMember

Used to create a new Customer record in the Optimus Cards system. <br> A Customer is the Individual or Corporate entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus.


/party/customers/CreateMember

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/CreateMember?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateMemberRequestBody payload = ; // CreateMemberRequestBody | body Payload
        try {
            CreateMemberResponse result = apiInstance.createMember(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#createMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateMemberRequestBody payload = ; // CreateMemberRequestBody | body Payload
        try {
            CreateMemberResponse result = apiInstance.createMember(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#createMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
CreateMemberRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Used to create a new Customer record in the Optimus Cards system. 
A Customer is the Individual or Corporate entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus. [apiInstance createMemberWith:requestID payload:payload completionHandler: ^(CreateMemberResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {CreateMemberRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMember(requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new CreateMemberRequestBody(); // CreateMemberRequestBody | body Payload

            try
            {
                // Used to create a new Customer record in the Optimus Cards system. 
A Customer is the Individual or Corporate entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus. CreateMemberResponse result = apiInstance.createMember(requestID, payload); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling CustomerApi.createMember: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // CreateMemberRequestBody | body Payload

try {
    $result = $api_instance->createMember($requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->createMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::CreateMemberRequestBody->new(); # CreateMemberRequestBody | body Payload

eval { 
    my $result = $api_instance->createMember(requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->createMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # CreateMemberRequestBody | body Payload

try: 
    # Used to create a new Customer record in the Optimus Cards system. 
A Customer is the Individual or Corporate entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus. api_response = api_instance.create_member(requestID, payload) pprint(api_response) except ApiException as e: print("Exception when calling CustomerApi->createMember: %s\n" % e)

Parameters

Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - CreateMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getAccountsByMember

Retrieve all Accounts for customer

Method used to retrieve all Accounts for specific customer.


/party/customers/GetAccountsByMember/{externalCustomerID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/GetAccountsByMember/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetAccountsByMemberResponse result = apiInstance.getAccountsByMember(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getAccountsByMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetAccountsByMemberResponse result = apiInstance.getAccountsByMember(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getAccountsByMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Retrieve all Accounts for customer
[apiInstance getAccountsByMemberWith:externalCustomerID
    requestID:requestID
              completionHandler: ^(GetAccountsByMemberResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountsByMember(externalCustomerID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountsByMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve all Accounts for customer
                GetAccountsByMemberResponse result = apiInstance.getAccountsByMember(externalCustomerID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.getAccountsByMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getAccountsByMember($externalCustomerID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getAccountsByMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getAccountsByMember(externalCustomerID => $externalCustomerID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->getAccountsByMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve all Accounts for customer
    api_response = api_instance.get_accounts_by_member(externalCustomerID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->getAccountsByMember: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetAccountsByMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getBeneficiariesByMember

Retrieve all Beneficiaries for given customer

Method used to retrieve all Beneficiaries setup for specific customer.


/party/customers/GetBeneficiariesByMember/{externalCustomerID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/GetBeneficiariesByMember/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetBeneficiariesByMemberResponse result = apiInstance.getBeneficiariesByMember(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getBeneficiariesByMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetBeneficiariesByMemberResponse result = apiInstance.getBeneficiariesByMember(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getBeneficiariesByMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Retrieve all Beneficiaries for given customer
[apiInstance getBeneficiariesByMemberWith:externalCustomerID
    requestID:requestID
              completionHandler: ^(GetBeneficiariesByMemberResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBeneficiariesByMember(externalCustomerID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBeneficiariesByMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve all Beneficiaries for given customer
                GetBeneficiariesByMemberResponse result = apiInstance.getBeneficiariesByMember(externalCustomerID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.getBeneficiariesByMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getBeneficiariesByMember($externalCustomerID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getBeneficiariesByMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getBeneficiariesByMember(externalCustomerID => $externalCustomerID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->getBeneficiariesByMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve all Beneficiaries for given customer
    api_response = api_instance.get_beneficiaries_by_member(externalCustomerID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->getBeneficiariesByMember: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetCardsByMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getCardsByMember

Retrieve all Cards for customer

Method used to retrieve all Cards for specific customer.


/party/customers/GetCardsByMember/{externalCustomerID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/GetCardsByMember/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardsByMemberResponse result = apiInstance.getCardsByMember(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getCardsByMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetCardsByMemberResponse result = apiInstance.getCardsByMember(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getCardsByMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Retrieve all Cards for customer
[apiInstance getCardsByMemberWith:externalCustomerID
    requestID:requestID
              completionHandler: ^(GetCardsByMemberResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCardsByMember(externalCustomerID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardsByMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve all Cards for customer
                GetCardsByMemberResponse result = apiInstance.getCardsByMember(externalCustomerID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.getCardsByMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getCardsByMember($externalCustomerID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getCardsByMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getCardsByMember(externalCustomerID => $externalCustomerID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->getCardsByMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve all Cards for customer
    api_response = api_instance.get_cards_by_member(externalCustomerID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->getCardsByMember: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetCardsByMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getConsent

Retrieve all marketing consent options for given customer

Method used to retrieve all marketing consent options for specific customer.


/party/customers/GetConsent/{externalCustomerID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/GetConsent/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetConsentResponse result = apiInstance.getConsent(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetConsentResponse result = apiInstance.getConsent(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Retrieve all marketing consent options for given customer
[apiInstance getConsentWith:externalCustomerID
    requestID:requestID
              completionHandler: ^(GetConsentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsent(externalCustomerID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsentExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve all marketing consent options for given customer
                GetConsentResponse result = apiInstance.getConsent(externalCustomerID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.getConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getConsent($externalCustomerID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getConsent(externalCustomerID => $externalCustomerID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->getConsent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve all marketing consent options for given customer
    api_response = api_instance.get_consent(externalCustomerID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->getConsent: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetConsentResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getMemberDetails

New customer record

Method used to retrieve current information held in Optimus CMS about specific Customer.


/party/customers/GetMemberDetails/{externalCustomerID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/GetMemberDetails/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetMemberDetailsResponse result = apiInstance.getMemberDetails(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getMemberDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetMemberDetailsResponse result = apiInstance.getMemberDetails(externalCustomerID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getMemberDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// New customer record
[apiInstance getMemberDetailsWith:externalCustomerID
    requestID:requestID
              completionHandler: ^(GetMemberDetailsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMemberDetails(externalCustomerID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMemberDetailsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // New customer record
                GetMemberDetailsResponse result = apiInstance.getMemberDetails(externalCustomerID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.getMemberDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getMemberDetails($externalCustomerID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getMemberDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getMemberDetails(externalCustomerID => $externalCustomerID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->getMemberDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # New customer record
    api_response = api_instance.get_member_details(externalCustomerID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->getMemberDetails: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetMemberDetailsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getMemberUUID

Used to generate a UUID to be used for the customer due diligence documents submission to an external Identity & Verification provider


/party/customers/GetMemberUUID

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/GetMemberUUID?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetMemberUUIDRequestBody payload = ; // GetMemberUUIDRequestBody | body Payload
        try {
            GetMemberUUIDResponse result = apiInstance.getMemberUUID(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getMemberUUID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        GetMemberUUIDRequestBody payload = ; // GetMemberUUIDRequestBody | body Payload
        try {
            GetMemberUUIDResponse result = apiInstance.getMemberUUID(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#getMemberUUID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
GetMemberUUIDRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Used to generate a UUID to be used for the customer due diligence documents submission to an external Identity & Verification provider
[apiInstance getMemberUUIDWith:requestID
    payload:payload
              completionHandler: ^(GetMemberUUIDResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {GetMemberUUIDRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMemberUUID(requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMemberUUIDExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new GetMemberUUIDRequestBody(); // GetMemberUUIDRequestBody | body Payload

            try
            {
                // Used to generate a UUID to be used for the customer due diligence documents submission to an external Identity & Verification provider
                GetMemberUUIDResponse result = apiInstance.getMemberUUID(requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.getMemberUUID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // GetMemberUUIDRequestBody | body Payload

try {
    $result = $api_instance->getMemberUUID($requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getMemberUUID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::GetMemberUUIDRequestBody->new(); # GetMemberUUIDRequestBody | body Payload

eval { 
    my $result = $api_instance->getMemberUUID(requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->getMemberUUID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # GetMemberUUIDRequestBody | body Payload

try: 
    # Used to generate a UUID to be used for the customer due diligence documents submission to an external Identity & Verification provider
    api_response = api_instance.get_member_uuid(requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->getMemberUUID: %s\n" % e)

Parameters

Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetMemberUUIDResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


searchMember

Used to search a Customer record in the Optimus Cards system. <br> A Customer is the Individual or Corporate Entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus.


/party/customers/SearchMember

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/SearchMember?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SearchMemberRequestBody payload = ; // SearchMemberRequestBody | body Payload
        try {
            SearchMemberResponse result = apiInstance.searchMember(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#searchMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SearchMemberRequestBody payload = ; // SearchMemberRequestBody | body Payload
        try {
            SearchMemberResponse result = apiInstance.searchMember(requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#searchMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
SearchMemberRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Used to search a Customer record in the Optimus Cards system. 
A Customer is the Individual or Corporate Entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus. [apiInstance searchMemberWith:requestID payload:payload completionHandler: ^(SearchMemberResponse output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {SearchMemberRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchMember(requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new SearchMemberRequestBody(); // SearchMemberRequestBody | body Payload

            try
            {
                // Used to search a Customer record in the Optimus Cards system. 
A Customer is the Individual or Corporate Entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus. SearchMemberResponse result = apiInstance.searchMember(requestID, payload); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling CustomerApi.searchMember: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // SearchMemberRequestBody | body Payload

try {
    $result = $api_instance->searchMember($requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->searchMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::SearchMemberRequestBody->new(); # SearchMemberRequestBody | body Payload

eval { 
    my $result = $api_instance->searchMember(requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->searchMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # SearchMemberRequestBody | body Payload

try: 
    # Used to search a Customer record in the Optimus Cards system. 
A Customer is the Individual or Corporate Entity that may hold accounts/wallets/balances with Optimus and may have cards issued by Optimus. api_response = api_instance.search_member(requestID, payload) pprint(api_response) except ApiException as e: print("Exception when calling CustomerApi->searchMember: %s\n" % e)

Parameters

Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - SearchMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateBeneficiary

Method used to update an existing Beneficiary`s data in the Optimus Cards system.


/party/customers/UpdateBeneficiary/{externalCustomerID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/UpdateBeneficiary/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer that is being updated
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateBeneficiaryRequestBody payload = ; // UpdateBeneficiaryRequestBody | body Payload
        try {
            UpdateBeneficiaryResponse result = apiInstance.updateBeneficiary(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#updateBeneficiary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer that is being updated
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateBeneficiaryRequestBody payload = ; // UpdateBeneficiaryRequestBody | body Payload
        try {
            UpdateBeneficiaryResponse result = apiInstance.updateBeneficiary(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#updateBeneficiary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // Unique identifier from the partner`s system for the Customer that is being updated
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateBeneficiaryRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

[apiInstance updateBeneficiaryWith:externalCustomerID
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateBeneficiaryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} Unique identifier from the partner`s system for the Customer that is being updated

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateBeneficiaryRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBeneficiary(externalCustomerID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateBeneficiaryExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | Unique identifier from the partner`s system for the Customer that is being updated
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateBeneficiaryRequestBody(); // UpdateBeneficiaryRequestBody | body Payload

            try
            {
                UpdateBeneficiaryResponse result = apiInstance.updateBeneficiary(externalCustomerID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.updateBeneficiary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer that is being updated
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateBeneficiaryRequestBody | body Payload

try {
    $result = $api_instance->updateBeneficiary($externalCustomerID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->updateBeneficiary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | Unique identifier from the partner`s system for the Customer that is being updated
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateBeneficiaryRequestBody->new(); # UpdateBeneficiaryRequestBody | body Payload

eval { 
    my $result = $api_instance->updateBeneficiary(externalCustomerID => $externalCustomerID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->updateBeneficiary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | Unique identifier from the partner`s system for the Customer that is being updated
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateBeneficiaryRequestBody | body Payload

try: 
    api_response = api_instance.update_beneficiary(externalCustomerID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->updateBeneficiary: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Unique identifier from the partner`s system for the Customer that is being updated
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateBeneficiaryResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateConsent

Used to update Customers options for marketing consent.


/party/customers/UpdateConsent/{externalCustomerID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/UpdateConsent/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer.
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateConsentRequestBody payload = ; // UpdateConsentRequestBody | body Payload
        try {
            UpdateConsentResponse result = apiInstance.updateConsent(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#updateConsent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer.
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateConsentRequestBody payload = ; // UpdateConsentRequestBody | body Payload
        try {
            UpdateConsentResponse result = apiInstance.updateConsent(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#updateConsent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // Unique identifier from the partner`s system for the Customer.
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateConsentRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

// Used to update Customers options for marketing consent.
[apiInstance updateConsentWith:externalCustomerID
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateConsentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} Unique identifier from the partner`s system for the Customer.

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateConsentRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConsent(externalCustomerID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateConsentExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | Unique identifier from the partner`s system for the Customer.
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateConsentRequestBody(); // UpdateConsentRequestBody | body Payload

            try
            {
                // Used to update Customers options for marketing consent.
                UpdateConsentResponse result = apiInstance.updateConsent(externalCustomerID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.updateConsent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer.
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateConsentRequestBody | body Payload

try {
    $result = $api_instance->updateConsent($externalCustomerID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->updateConsent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | Unique identifier from the partner`s system for the Customer.
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateConsentRequestBody->new(); # UpdateConsentRequestBody | body Payload

eval { 
    my $result = $api_instance->updateConsent(externalCustomerID => $externalCustomerID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->updateConsent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | Unique identifier from the partner`s system for the Customer.
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateConsentRequestBody | body Payload

try: 
    # Used to update Customers options for marketing consent.
    api_response = api_instance.update_consent(externalCustomerID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->updateConsent: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Unique identifier from the partner`s system for the Customer.
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateConsentResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateMember

Method used to update an existing Customer`s data in the Optimus Cards system. <br> Changes to personal and contact details must be kept up to date in CMS to cards and cards correspondence is processed correctly and e-commerce transactions are properly validated.


/party/customers/UpdateMember/{externalCustomerID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/party/customers/UpdateMember/{externalCustomerID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomerApi;

import java.io.File;
import java.util.*;

public class CustomerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer that is being updated
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateMemberRequestBody payload = ; // UpdateMemberRequestBody | body Payload
        try {
            UpdateMemberResponse result = apiInstance.updateMember(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#updateMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomerApi;

public class CustomerApiExample {

    public static void main(String[] args) {
        CustomerApi apiInstance = new CustomerApi();
        String externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer that is being updated
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateMemberRequestBody payload = ; // UpdateMemberRequestBody | body Payload
        try {
            UpdateMemberResponse result = apiInstance.updateMember(externalCustomerID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomerApi#updateMember");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalCustomerID = externalCustomerID_example; // Unique identifier from the partner`s system for the Customer that is being updated
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateMemberRequestBody *payload = ; // body Payload

CustomerApi *apiInstance = [[CustomerApi alloc] init];

[apiInstance updateMemberWith:externalCustomerID
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateMemberResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.CustomerApi()

var externalCustomerID = externalCustomerID_example; // {String} Unique identifier from the partner`s system for the Customer that is being updated

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateMemberRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateMember(externalCustomerID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateMemberExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CustomerApi();
            var externalCustomerID = externalCustomerID_example;  // String | Unique identifier from the partner`s system for the Customer that is being updated
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateMemberRequestBody(); // UpdateMemberRequestBody | body Payload

            try
            {
                UpdateMemberResponse result = apiInstance.updateMember(externalCustomerID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomerApi.updateMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CustomerApi();
$externalCustomerID = externalCustomerID_example; // String | Unique identifier from the partner`s system for the Customer that is being updated
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateMemberRequestBody | body Payload

try {
    $result = $api_instance->updateMember($externalCustomerID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->updateMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomerApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CustomerApi->new();
my $externalCustomerID = externalCustomerID_example; # String | Unique identifier from the partner`s system for the Customer that is being updated
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateMemberRequestBody->new(); # UpdateMemberRequestBody | body Payload

eval { 
    my $result = $api_instance->updateMember(externalCustomerID => $externalCustomerID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerApi->updateMember: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomerApi()
externalCustomerID = externalCustomerID_example # String | Unique identifier from the partner`s system for the Customer that is being updated
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateMemberRequestBody | body Payload

try: 
    api_response = api_instance.update_member(externalCustomerID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomerApi->updateMember: %s\n" % e)

Parameters

Path parameters
Name Description
externalCustomerID*
String
Unique identifier from the partner`s system for the Customer that is being updated
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateMemberResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Security

getPublicKey

Retrieve Public RSA key to use in encryption operations

Method is used to retrieve public RSA key which can be used to transfer sensitve data a secure way. In response Optimus returns the RSA key and its index.


/security/key/GetPublicKey

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/security/key/GetPublicKey?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        SecurityApi apiInstance = new SecurityApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetPublicKeyResponse result = apiInstance.getPublicKey(requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getPublicKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SecurityApi;

public class SecurityApiExample {

    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetPublicKeyResponse result = apiInstance.getPublicKey(requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#getPublicKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

SecurityApi *apiInstance = [[SecurityApi alloc] init];

// Retrieve Public RSA key to use in encryption operations
[apiInstance getPublicKeyWith:requestID
              completionHandler: ^(GetPublicKeyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.SecurityApi()

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPublicKey(requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPublicKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new SecurityApi();
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve Public RSA key to use in encryption operations
                GetPublicKeyResponse result = apiInstance.getPublicKey(requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SecurityApi.getPublicKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\SecurityApi();
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getPublicKey($requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->getPublicKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SecurityApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SecurityApi->new();
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getPublicKey(requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->getPublicKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SecurityApi()
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve Public RSA key to use in encryption operations
    api_response = api_instance.get_public_key(requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->getPublicKey: %s\n" % e)

Parameters

Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetPublicKeyResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


oauthTokenPost

Used to obtain the token for authenticated access. This can be accessed at: https://dev.optimuscards.com/oauth/token. Optimus will provide your username and password.


/oauth/token

Usage and SDK Samples

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Basic [[basicHash]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/oauth/token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SecurityApi;

import java.io.File;
import java.util.*;

public class SecurityApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        SecurityApi apiInstance = new SecurityApi();
        String grantType = grantType_example; // String | Use grant_type password
        String username = username_example; // String | Username provided by Optimus for your Entity
        String password = password_example; // String | Password provided by Optimus for your Entity
        try {
            tokenResponse result = apiInstance.oauthTokenPost(grantType, username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#oauthTokenPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SecurityApi;

public class SecurityApiExample {

    public static void main(String[] args) {
        SecurityApi apiInstance = new SecurityApi();
        String grantType = grantType_example; // String | Use grant_type password
        String username = username_example; // String | Username provided by Optimus for your Entity
        String password = password_example; // String | Password provided by Optimus for your Entity
        try {
            tokenResponse result = apiInstance.oauthTokenPost(grantType, username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SecurityApi#oauthTokenPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *grantType = grantType_example; // Use grant_type password
String *username = username_example; // Username provided by Optimus for your Entity
String *password = password_example; // Password provided by Optimus for your Entity

SecurityApi *apiInstance = [[SecurityApi alloc] init];

// Used to obtain the token for authenticated access. This can be accessed at: https://dev.optimuscards.com/oauth/token. Optimus will provide your username and password.
[apiInstance oauthTokenPostWith:grantType
    username:username
    password:password
              completionHandler: ^(tokenResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new OptimusCardsRestApis.SecurityApi()

var grantType = grantType_example; // {String} Use grant_type password

var username = username_example; // {String} Username provided by Optimus for your Entity

var password = password_example; // {String} Password provided by Optimus for your Entity


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.oauthTokenPost(grantType, username, password, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class oauthTokenPostExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new SecurityApi();
            var grantType = grantType_example;  // String | Use grant_type password
            var username = username_example;  // String | Username provided by Optimus for your Entity
            var password = password_example;  // String | Password provided by Optimus for your Entity

            try
            {
                // Used to obtain the token for authenticated access. This can be accessed at: https://dev.optimuscards.com/oauth/token. Optimus will provide your username and password.
                tokenResponse result = apiInstance.oauthTokenPost(grantType, username, password);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SecurityApi.oauthTokenPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\SecurityApi();
$grantType = grantType_example; // String | Use grant_type password
$username = username_example; // String | Username provided by Optimus for your Entity
$password = password_example; // String | Password provided by Optimus for your Entity

try {
    $result = $api_instance->oauthTokenPost($grantType, $username, $password);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecurityApi->oauthTokenPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SecurityApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::SecurityApi->new();
my $grantType = grantType_example; # String | Use grant_type password
my $username = username_example; # String | Username provided by Optimus for your Entity
my $password = password_example; # String | Password provided by Optimus for your Entity

eval { 
    my $result = $api_instance->oauthTokenPost(grantType => $grantType, username => $username, password => $password);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SecurityApi->oauthTokenPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.SecurityApi()
grantType = grantType_example # String | Use grant_type password
username = username_example # String | Username provided by Optimus for your Entity
password = password_example # String | Password provided by Optimus for your Entity

try: 
    # Used to obtain the token for authenticated access. This can be accessed at: https://dev.optimuscards.com/oauth/token. Optimus will provide your username and password.
    api_response = api_instance.oauth_token_post(grantType, username, password)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SecurityApi->oauthTokenPost: %s\n" % e)

Parameters

Form parameters
Name Description
grant_type*
String
Use grant_type password
Required
username*
String
Username provided by Optimus for your Entity
Required
password*
String
Password provided by Optimus for your Entity
Required

Responses

Status: 200 - Token returned


Simulator

payment

Simulate incoming payments for testing purposes

Method used to simulate an incoming payment into an account.


/simulator/payment/{externalAccountID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/simulator/payment/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SimulatorApi;

import java.io.File;
import java.util.*;

public class SimulatorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        SimulatorApi apiInstance = new SimulatorApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SimPaymentRequestBody payload = ; // SimPaymentRequestBody | body Payload
        try {
            SimPaymentResponse result = apiInstance.payment(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimulatorApi#payment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SimulatorApi;

public class SimulatorApiExample {

    public static void main(String[] args) {
        SimulatorApi apiInstance = new SimulatorApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        SimPaymentRequestBody payload = ; // SimPaymentRequestBody | body Payload
        try {
            SimPaymentResponse result = apiInstance.payment(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimulatorApi#payment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
SimPaymentRequestBody *payload = ; // body Payload

SimulatorApi *apiInstance = [[SimulatorApi alloc] init];

// Simulate incoming payments for testing purposes
[apiInstance paymentWith:externalAccountID
    requestID:requestID
    payload:payload
              completionHandler: ^(SimPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.SimulatorApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {SimPaymentRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.payment(externalAccountID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class paymentExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new SimulatorApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new SimPaymentRequestBody(); // SimPaymentRequestBody | body Payload

            try
            {
                // Simulate incoming payments for testing purposes
                SimPaymentResponse result = apiInstance.payment(externalAccountID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SimulatorApi.payment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\SimulatorApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // SimPaymentRequestBody | body Payload

try {
    $result = $api_instance->payment($externalAccountID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SimulatorApi->payment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SimulatorApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SimulatorApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::SimPaymentRequestBody->new(); # SimPaymentRequestBody | body Payload

eval { 
    my $result = $api_instance->payment(externalAccountID => $externalAccountID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SimulatorApi->payment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SimulatorApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # SimPaymentRequestBody | body Payload

try: 
    # Simulate incoming payments for testing purposes
    api_response = api_instance.payment(externalAccountID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SimulatorApi->payment: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - paymentResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


Transactions

cancelDirectDebit

Cancel a DDI

Method used to cancel a specific direct debit instruction.


/transactions/CancelDirectDebit/{mandateID}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/transactions/CancelDirectDebit/{mandateID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        TransactionsApi apiInstance = new TransactionsApi();
        String mandateID = mandateID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            CancelDirectDebitResponse result = apiInstance.cancelDirectDebit(mandateID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#cancelDirectDebit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String mandateID = mandateID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            CancelDirectDebitResponse result = apiInstance.cancelDirectDebit(mandateID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#cancelDirectDebit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *mandateID = mandateID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Cancel a DDI
[apiInstance cancelDirectDebitWith:mandateID
    requestID:requestID
              completionHandler: ^(CancelDirectDebitResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.TransactionsApi()

var mandateID = mandateID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelDirectDebit(mandateID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelDirectDebitExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TransactionsApi();
            var mandateID = mandateID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Cancel a DDI
                CancelDirectDebitResponse result = apiInstance.cancelDirectDebit(mandateID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.cancelDirectDebit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$mandateID = mandateID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->cancelDirectDebit($mandateID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->cancelDirectDebit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $mandateID = mandateID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->cancelDirectDebit(mandateID => $mandateID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->cancelDirectDebit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
mandateID = mandateID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Cancel a DDI
    api_response = api_instance.cancel_direct_debit(mandateID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->cancelDirectDebit: %s\n" % e)

Parameters

Path parameters
Name Description
mandateID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - CancelDirectDebitResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


createTransaction

Create and commit account transaction

Method used to create an account payment transaction for a specific account.


/transactions/CreateTransaction/{externalAccountID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/transactions/CreateTransaction/{externalAccountID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        TransactionsApi apiInstance = new TransactionsApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateTransactionRequestBody payload = ; // CreateTransactionRequestBody | body Payload
        try {
            CreateTransactionResponse result = apiInstance.createTransaction(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#createTransaction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String externalAccountID = externalAccountID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        CreateTransactionRequestBody payload = ; // CreateTransactionRequestBody | body Payload
        try {
            CreateTransactionResponse result = apiInstance.createTransaction(externalAccountID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#createTransaction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *externalAccountID = externalAccountID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
CreateTransactionRequestBody *payload = ; // body Payload

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Create and commit account transaction
[apiInstance createTransactionWith:externalAccountID
    requestID:requestID
    payload:payload
              completionHandler: ^(CreateTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.TransactionsApi()

var externalAccountID = externalAccountID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {CreateTransactionRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTransaction(externalAccountID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTransactionExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TransactionsApi();
            var externalAccountID = externalAccountID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new CreateTransactionRequestBody(); // CreateTransactionRequestBody | body Payload

            try
            {
                // Create and commit account transaction
                CreateTransactionResponse result = apiInstance.createTransaction(externalAccountID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.createTransaction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$externalAccountID = externalAccountID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // CreateTransactionRequestBody | body Payload

try {
    $result = $api_instance->createTransaction($externalAccountID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->createTransaction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $externalAccountID = externalAccountID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::CreateTransactionRequestBody->new(); # CreateTransactionRequestBody | body Payload

eval { 
    my $result = $api_instance->createTransaction(externalAccountID => $externalAccountID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->createTransaction: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
externalAccountID = externalAccountID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # CreateTransactionRequestBody | body Payload

try: 
    # Create and commit account transaction
    api_response = api_instance.create_transaction(externalAccountID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->createTransaction: %s\n" % e)

Parameters

Path parameters
Name Description
externalAccountID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetTransactionsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


getTransactionDetails

Retrieve details for a transaction

Method used to retrieve transaction history for a specific account.


/transactions/GetTransactionDetails/{transactionReferenceID}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/transactions/GetTransactionDetails/{transactionReferenceID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        TransactionsApi apiInstance = new TransactionsApi();
        String transactionReferenceID = transactionReferenceID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetTransactionsResponse result = apiInstance.getTransactionDetails(transactionReferenceID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTransactionDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String transactionReferenceID = transactionReferenceID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        try {
            GetTransactionsResponse result = apiInstance.getTransactionDetails(transactionReferenceID, requestID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#getTransactionDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *transactionReferenceID = transactionReferenceID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Retrieve details for a transaction
[apiInstance getTransactionDetailsWith:transactionReferenceID
    requestID:requestID
              completionHandler: ^(GetTransactionsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.TransactionsApi()

var transactionReferenceID = transactionReferenceID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTransactionDetails(transactionReferenceID, requestID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTransactionDetailsExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TransactionsApi();
            var transactionReferenceID = transactionReferenceID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

            try
            {
                // Retrieve details for a transaction
                GetTransactionsResponse result = apiInstance.getTransactionDetails(transactionReferenceID, requestID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.getTransactionDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$transactionReferenceID = transactionReferenceID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try {
    $result = $api_instance->getTransactionDetails($transactionReferenceID, $requestID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->getTransactionDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $transactionReferenceID = transactionReferenceID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

eval { 
    my $result = $api_instance->getTransactionDetails(transactionReferenceID => $transactionReferenceID, requestID => $requestID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->getTransactionDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
transactionReferenceID = transactionReferenceID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

try: 
    # Retrieve details for a transaction
    api_response = api_instance.get_transaction_details(transactionReferenceID, requestID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->getTransactionDetails: %s\n" % e)

Parameters

Path parameters
Name Description
transactionReferenceID*
String
Required
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - GetTransactionsResponse

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable


updateScheduledPayment

Update or cancel a scheduled payment

Method used to update or cancel a specific scheduled payment instruction.


/transactions/UpdateScheduledPayment/{scheduleID}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://virtserver.swaggerhub.com/OptimusCards/Rest/1.0.0/transactions/UpdateScheduledPayment/{scheduleID}?requestID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TransactionsApi;

import java.io.File;
import java.util.*;

public class TransactionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        TransactionsApi apiInstance = new TransactionsApi();
        String scheduleID = scheduleID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateScheduledPaymentRequestBody payload = ; // UpdateScheduledPaymentRequestBody | body Payload
        try {
            UpdateScheduledPaymentResponse result = apiInstance.updateScheduledPayment(scheduleID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#updateScheduledPayment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TransactionsApi;

public class TransactionsApiExample {

    public static void main(String[] args) {
        TransactionsApi apiInstance = new TransactionsApi();
        String scheduleID = scheduleID_example; // String | 
        String requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
        UpdateScheduledPaymentRequestBody payload = ; // UpdateScheduledPaymentRequestBody | body Payload
        try {
            UpdateScheduledPaymentResponse result = apiInstance.updateScheduledPayment(scheduleID, requestID, payload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TransactionsApi#updateScheduledPayment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *scheduleID = scheduleID_example; // 
String *requestID = requestID_example; // Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
UpdateScheduledPaymentRequestBody *payload = ; // body Payload

TransactionsApi *apiInstance = [[TransactionsApi alloc] init];

// Update or cancel a scheduled payment
[apiInstance updateScheduledPaymentWith:scheduleID
    requestID:requestID
    payload:payload
              completionHandler: ^(UpdateScheduledPaymentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OptimusCardsRestApis = require('optimus_cards_rest_apis');
var defaultClient = OptimusCardsRestApis.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new OptimusCardsRestApis.TransactionsApi()

var scheduleID = scheduleID_example; // {String} 

var requestID = requestID_example; // {String} Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6

var payload = ; // {UpdateScheduledPaymentRequestBody} body Payload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateScheduledPayment(scheduleID, requestID, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateScheduledPaymentExample
    {
        public void main()
        {
            
            // Configure API key authorization: bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new TransactionsApi();
            var scheduleID = scheduleID_example;  // String | 
            var requestID = requestID_example;  // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
            var payload = new UpdateScheduledPaymentRequestBody(); // UpdateScheduledPaymentRequestBody | body Payload

            try
            {
                // Update or cancel a scheduled payment
                UpdateScheduledPaymentResponse result = apiInstance.updateScheduledPayment(scheduleID, requestID, payload);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TransactionsApi.updateScheduledPayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\TransactionsApi();
$scheduleID = scheduleID_example; // String | 
$requestID = requestID_example; // String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
$payload = ; // UpdateScheduledPaymentRequestBody | body Payload

try {
    $result = $api_instance->updateScheduledPayment($scheduleID, $requestID, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->updateScheduledPayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TransactionsApi;

# Configure API key authorization: bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TransactionsApi->new();
my $scheduleID = scheduleID_example; # String | 
my $requestID = requestID_example; # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
my $payload = WWW::SwaggerClient::Object::UpdateScheduledPaymentRequestBody->new(); # UpdateScheduledPaymentRequestBody | body Payload

eval { 
    my $result = $api_instance->updateScheduledPayment(scheduleID => $scheduleID, requestID => $requestID, payload => $payload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TransactionsApi->updateScheduledPayment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TransactionsApi()
scheduleID = scheduleID_example # String | 
requestID = requestID_example # String | Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
payload =  # UpdateScheduledPaymentRequestBody | body Payload

try: 
    # Update or cancel a scheduled payment
    api_response = api_instance.update_scheduled_payment(scheduleID, requestID, payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TransactionsApi->updateScheduledPayment: %s\n" % e)

Parameters

Path parameters
Name Description
scheduleID*
String
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
requestID*
String
Unique request identifier (uuid) prefixed by your Entity identifier provided by Optimus. E.g. OPT-9d8d4b6e-8c5c-447b-95bc-146d3e1dd2f6
Required

Responses

Status: 200 - UpdateScheduledPayment

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 409 - Duplicated Entry

Status: 500 - Internal Server Error

Status: 503 - Temporary Unavailable