Cards

Delete Customers ID Cards Card ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Delete Customers ID Cards Card ID

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X DELETE\
-H "Accept: application/json"\
"https://api.omise.co/customers/{id}/cards/{card_id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        String cardId = cardId_example; // String | 
        try {
            card result = apiInstance.customersIdCardsCardIdDelete(id, cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsCardIdDelete");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        String cardId = cardId_example; // String | 
        try {
            card result = apiInstance.customersIdCardsCardIdDelete(id, cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsCardIdDelete");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
String *cardId = cardId_example; // 

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

[apiInstance customersIdCardsCardIdDeleteWith:id
    cardId:cardId
              completionHandler: ^(card output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.CardsApi()
var id = id_example; // {{String}} 
var cardId = cardId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customersIdCardsCardIdDelete(id, cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class customersIdCardsCardIdDeleteExample
    {
        public void main()
        {

            var apiInstance = new CardsApi();
            var id = id_example;  // String | 
            var cardId = cardId_example;  // String | 

            try
            {
                card result = apiInstance.customersIdCardsCardIdDelete(id, cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.customersIdCardsCardIdDelete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCardsApi();
$id = id_example; // String | 
$cardId = cardId_example; // String | 

try {
    $result = $api_instance->customersIdCardsCardIdDelete($id, $cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->customersIdCardsCardIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $id = id_example; # String | 
my $cardId = cardId_example; # String | 

eval { 
    my $result = $api_instance->customersIdCardsCardIdDelete(id => $id, cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardsApi->customersIdCardsCardIdDelete: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CardsApi()
id = id_example # String | 
cardId = cardId_example # String | 

try: 
    api_response = api_instance.customers_id_cards_card_id_delete(id, cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->customersIdCardsCardIdDelete: %s\n" % e)

Parameters

Name	Description
id*	String Required
card_id*	String Required

Retrieve Customers ID Cards Card ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Customers ID Cards Card ID

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/customers/{id}/cards/{card_id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        String cardId = cardId_example; // String | 
        try {
            card result = apiInstance.customersIdCardsCardIdGet(id, cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsCardIdGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        String cardId = cardId_example; // String | 
        try {
            card result = apiInstance.customersIdCardsCardIdGet(id, cardId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsCardIdGet");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
String *cardId = cardId_example; // 

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

[apiInstance customersIdCardsCardIdGetWith:id
    cardId:cardId
              completionHandler: ^(card output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.CardsApi()
var id = id_example; // {{String}} 
var cardId = cardId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customersIdCardsCardIdGet(id, cardId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class customersIdCardsCardIdGetExample
    {
        public void main()
        {

            var apiInstance = new CardsApi();
            var id = id_example;  // String | 
            var cardId = cardId_example;  // String | 

            try
            {
                card result = apiInstance.customersIdCardsCardIdGet(id, cardId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.customersIdCardsCardIdGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCardsApi();
$id = id_example; // String | 
$cardId = cardId_example; // String | 

try {
    $result = $api_instance->customersIdCardsCardIdGet($id, $cardId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->customersIdCardsCardIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $id = id_example; # String | 
my $cardId = cardId_example; # String | 

eval { 
    my $result = $api_instance->customersIdCardsCardIdGet(id => $id, cardId => $cardId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardsApi->customersIdCardsCardIdGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CardsApi()
id = id_example # String | 
cardId = cardId_example # String | 

try: 
    api_response = api_instance.customers_id_cards_card_id_get(id, cardId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->customersIdCardsCardIdGet: %s\n" % e)

Parameters

Name	Description
id*	String Required
card_id*	String Required

Update Customers ID Cards Card ID

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Update Customers ID Cards Card ID

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/customers/{id}/cards/{card_id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        String cardId = cardId_example; // String | 
        String name = name_example; // String | 
        Integer expirationMonth = 56; // Integer | 
        Integer expirationYear = 56; // Integer | 
        String postalCode = postalCode_example; // String | 
        String city = city_example; // String | 
        try {
            card result = apiInstance.customersIdCardsCardIdPatch(id, cardId, name, expirationMonth, expirationYear, postalCode, city);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsCardIdPatch");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        String cardId = cardId_example; // String | 
        String name = name_example; // String | 
        Integer expirationMonth = 56; // Integer | 
        Integer expirationYear = 56; // Integer | 
        String postalCode = postalCode_example; // String | 
        String city = city_example; // String | 
        try {
            card result = apiInstance.customersIdCardsCardIdPatch(id, cardId, name, expirationMonth, expirationYear, postalCode, city);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsCardIdPatch");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
String *cardId = cardId_example; // 
String *name = name_example; //  (optional)
Integer *expirationMonth = 56; //  (optional)
Integer *expirationYear = 56; //  (optional)
String *postalCode = postalCode_example; //  (optional)
String *city = city_example; //  (optional)

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

[apiInstance customersIdCardsCardIdPatchWith:id
    cardId:cardId
    name:name
    expirationMonth:expirationMonth
    expirationYear:expirationYear
    postalCode:postalCode
    city:city
              completionHandler: ^(card output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.CardsApi()
var id = id_example; // {{String}} 
var cardId = cardId_example; // {{String}} 
var opts = { 
  'name': name_example // {{String}} 
  'expirationMonth': 56 // {{Integer}} 
  'expirationYear': 56 // {{Integer}} 
  'postalCode': postalCode_example // {{String}} 
  'city': city_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customersIdCardsCardIdPatch(idcardId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class customersIdCardsCardIdPatchExample
    {
        public void main()
        {

            var apiInstance = new CardsApi();
            var id = id_example;  // String | 
            var cardId = cardId_example;  // String | 
            var name = name_example;  // String |  (optional) 
            var expirationMonth = 56;  // Integer |  (optional) 
            var expirationYear = 56;  // Integer |  (optional) 
            var postalCode = postalCode_example;  // String |  (optional) 
            var city = city_example;  // String |  (optional) 

            try
            {
                card result = apiInstance.customersIdCardsCardIdPatch(id, cardId, name, expirationMonth, expirationYear, postalCode, city);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.customersIdCardsCardIdPatch: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCardsApi();
$id = id_example; // String | 
$cardId = cardId_example; // String | 
$name = name_example; // String | 
$expirationMonth = 56; // Integer | 
$expirationYear = 56; // Integer | 
$postalCode = postalCode_example; // String | 
$city = city_example; // String | 

try {
    $result = $api_instance->customersIdCardsCardIdPatch($id, $cardId, $name, $expirationMonth, $expirationYear, $postalCode, $city);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->customersIdCardsCardIdPatch: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $id = id_example; # String | 
my $cardId = cardId_example; # String | 
my $name = name_example; # String | 
my $expirationMonth = 56; # Integer | 
my $expirationYear = 56; # Integer | 
my $postalCode = postalCode_example; # String | 
my $city = city_example; # String | 

eval { 
    my $result = $api_instance->customersIdCardsCardIdPatch(id => $id, cardId => $cardId, name => $name, expirationMonth => $expirationMonth, expirationYear => $expirationYear, postalCode => $postalCode, city => $city);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardsApi->customersIdCardsCardIdPatch: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CardsApi()
id = id_example # String | 
cardId = cardId_example # String | 
name = name_example # String |  (optional)
expirationMonth = 56 # Integer |  (optional)
expirationYear = 56 # Integer |  (optional)
postalCode = postalCode_example # String |  (optional)
city = city_example # String |  (optional)

try: 
    api_response = api_instance.customers_id_cards_card_id_patch(id, cardId, name=name, expirationMonth=expirationMonth, expirationYear=expirationYear, postalCode=postalCode, city=city)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->customersIdCardsCardIdPatch: %s\n" % e)

Parameters

Name	Description
id*	String Required
card_id*	String Required

Parameters

Name	Description
name	String
expiration_month	Integer
expiration_year	Integer
postal_code	String
city	String

Retrieve Customers ID Cards

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Customers ID Cards

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/customers/{id}/cards?from=&to=&offset=&limit=&order="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | 
        Integer limit = 56; // Integer | 
        String order = order_example; // String | 
        try {
            list result = apiInstance.customersIdCardsGet(id, from, to, offset, limit, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String id = id_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer offset = 56; // Integer | 
        Integer limit = 56; // Integer | 
        String order = order_example; // String | 
        try {
            list result = apiInstance.customersIdCardsGet(id, from, to, offset, limit, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#customersIdCardsGet");
            e.printStackTrace();
        }
    }
}

String *id = id_example; // 
Date *from = 2013-10-20T19:20:30+01:00; //  (optional) (default to 1970-01-01T00:00Z)
Date *to = 2013-10-20T19:20:30+01:00; //  (optional)
Integer *offset = 56; //  (optional) (default to 0)
Integer *limit = 56; //  (optional) (default to 20)
String *order = order_example; //  (optional) (default to chronological)

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

[apiInstance customersIdCardsGetWith:id
    from:from
    to:to
    offset:offset
    limit:limit
    order:order
              completionHandler: ^(list output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.CardsApi()
var id = id_example; // {{String}} 
var opts = { 
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'to': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'offset': 56, // {{Integer}} 
  'limit': 56, // {{Integer}} 
  'order': order_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customersIdCardsGet(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class customersIdCardsGetExample
    {
        public void main()
        {

            var apiInstance = new CardsApi();
            var id = id_example;  // String | 
            var from = 2013-10-20T19:20:30+01:00;  // Date |  (optional)  (default to 1970-01-01T00:00Z)
            var to = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var limit = 56;  // Integer |  (optional)  (default to 20)
            var order = order_example;  // String |  (optional)  (default to chronological)

            try
            {
                list result = apiInstance.customersIdCardsGet(id, from, to, offset, limit, order);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.customersIdCardsGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCardsApi();
$id = id_example; // String | 
$from = 2013-10-20T19:20:30+01:00; // Date | 
$to = 2013-10-20T19:20:30+01:00; // Date | 
$offset = 56; // Integer | 
$limit = 56; // Integer | 
$order = order_example; // String | 

try {
    $result = $api_instance->customersIdCardsGet($id, $from, $to, $offset, $limit, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->customersIdCardsGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $id = id_example; # String | 
my $from = 2013-10-20T19:20:30+01:00; # Date | 
my $to = 2013-10-20T19:20:30+01:00; # Date | 
my $offset = 56; # Integer | 
my $limit = 56; # Integer | 
my $order = order_example; # String | 

eval { 
    my $result = $api_instance->customersIdCardsGet(id => $id, from => $from, to => $to, offset => $offset, limit => $limit, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardsApi->customersIdCardsGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CardsApi()
id = id_example # String | 
from = 2013-10-20T19:20:30+01:00 # Date |  (optional) (default to 1970-01-01T00:00Z)
to = 2013-10-20T19:20:30+01:00 # Date |  (optional)
offset = 56 # Integer |  (optional) (default to 0)
limit = 56 # Integer |  (optional) (default to 20)
order = order_example # String |  (optional) (default to chronological)

try: 
    api_response = api_instance.customers_id_cards_get(id, from=from, to=to, offset=offset, limit=limit, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->customersIdCardsGet: %s\n" % e)

Parameters

Name	Description
id*	String Required

Parameters

Name	Description
from	Date (date-time)
to	Date (date-time)
offset	Integer
limit	Integer
order	String

Responses

Status: 200

 {
  "object": {
    "pattern": "card",
    "type": "string",
    "default": "card"
  },
  "id": {
    "type": "string"
  },
  "livemode": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "location": {
    "type": "string"
  },
  "deleted": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "street1": {
    "type": "string",
    "nullable": true
  },
  "street2": {
    "type": "string",
    "nullable": true
  },
  "city": {
    "type": "string",
    "nullable": true
  },
  "state": {
    "type": "string",
    "nullable": true
  },
  "phone_number": {
    "type": "string",
    "nullable": true
  },
  "postal_code": {
    "type": "string",
    "nullable": true
  },
  "country": {
    "pattern": "^[a-z]{0,2}$",
    "type": "string"
  },
  "financing": {
    "type": "string"
  },
  "bank": {
    "type": "string"
  },
  "brand": {
    "type": "string"
  },
  "fingerprint": {
    "type": "string"
  },
  "first_digits": {
    "pattern": "^[0-9]{6}$",
    "type": "string",
    "nullable": true
  },
  "last_digits": {
    "pattern": "^[0-9]{4}$",
    "type": "string"
  },
  "name": {
    "type": "string"
  },
  "expiration_month": {
    "type": "integer"
  },
  "expiration_year": {
    "type": "integer"
  },
  "security_code_check": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "tokenization_method": {
    "type": "string"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  }
}