Account

Update Account API Version

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 Account API Version

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X PATCH\
-H "Accept: application/json"\
"https://api.omise.co/account/api_version"

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) {
        
        AccountApi apiInstance = new AccountApi();
        try {
            account result = apiInstance.accountApiVersionPatch();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountApiVersionPatch");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            account result = apiInstance.accountApiVersionPatch();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountApiVersionPatch");
            e.printStackTrace();
        }
    }
}

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

[apiInstance accountApiVersionPatchWithCompletionHandler: 
              ^(account output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountApiVersionPatch(callback);

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

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

            var apiInstance = new AccountApi();

            try
            {
                account result = apiInstance.accountApiVersionPatch();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountApiVersionPatch: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAccountApi();

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

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

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

eval { 
    my $result = $api_instance->accountApiVersionPatch();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountApiVersionPatch: $@\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.AccountApi()

try: 
    api_response = api_instance.account_api_version_patch()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountApiVersionPatch: %s\n" % e)

Retrieve Account API Versions

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 Account API Versions

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/account/api_versions"

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) {
        
        AccountApi apiInstance = new AccountApi();
        try {
            account result = apiInstance.accountApiVersionsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountApiVersionsGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            account result = apiInstance.accountApiVersionsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountApiVersionsGet");
            e.printStackTrace();
        }
    }
}

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

[apiInstance accountApiVersionsGetWithCompletionHandler: 
              ^(account output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountApiVersionsGet(callback);

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

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

            var apiInstance = new AccountApi();

            try
            {
                account result = apiInstance.accountApiVersionsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountApiVersionsGet: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAccountApi();

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

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

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

eval { 
    my $result = $api_instance->accountApiVersionsGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountApiVersionsGet: $@\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.AccountApi()

try: 
    api_response = api_instance.account_api_versions_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountApiVersionsGet: %s\n" % e)

Update Account

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 Account

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://api.omise.co/account"

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) {
        
        AccountApi apiInstance = new AccountApi();
        Boolean chainEnabled = true; // Boolean | 
        Boolean zeroInterestInstallments = true; // Boolean | 
        String chainReturnUri = chainReturnUri_example; // String | 
        String webhookUri = webhookUri_example; // String | 
        account_metadata_export_keys metadataExportKeys = ; // account_metadata_export_keys | 
        try {
            account result = apiInstance.accountPatch(chainEnabled, zeroInterestInstallments, chainReturnUri, webhookUri, metadataExportKeys);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountPatch");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        Boolean chainEnabled = true; // Boolean | 
        Boolean zeroInterestInstallments = true; // Boolean | 
        String chainReturnUri = chainReturnUri_example; // String | 
        String webhookUri = webhookUri_example; // String | 
        account_metadata_export_keys metadataExportKeys = ; // account_metadata_export_keys | 
        try {
            account result = apiInstance.accountPatch(chainEnabled, zeroInterestInstallments, chainReturnUri, webhookUri, metadataExportKeys);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountPatch");
            e.printStackTrace();
        }
    }
}

Boolean *chainEnabled = true; //  (optional)
Boolean *zeroInterestInstallments = true; //  (optional)
String *chainReturnUri = chainReturnUri_example; //  (optional)
String *webhookUri = webhookUri_example; //  (optional)
account_metadata_export_keys *metadataExportKeys = ; //  (optional)

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

[apiInstance accountPatchWith:chainEnabled
    zeroInterestInstallments:zeroInterestInstallments
    chainReturnUri:chainReturnUri
    webhookUri:webhookUri
    metadataExportKeys:metadataExportKeys
              completionHandler: ^(account output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.AccountApi()
var opts = { 
  'chainEnabled': true // {{Boolean}} 
  'zeroInterestInstallments': true // {{Boolean}} 
  'chainReturnUri': chainReturnUri_example // {{String}} 
  'webhookUri': webhookUri_example // {{String}} 
  'metadataExportKeys':  // {{account_metadata_export_keys}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountPatch(opts, callback);

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

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

            var apiInstance = new AccountApi();
            var chainEnabled = true;  // Boolean |  (optional) 
            var zeroInterestInstallments = true;  // Boolean |  (optional) 
            var chainReturnUri = chainReturnUri_example;  // String |  (optional) 
            var webhookUri = webhookUri_example;  // String |  (optional) 
            var metadataExportKeys = new account_metadata_export_keys(); // account_metadata_export_keys |  (optional) 

            try
            {
                account result = apiInstance.accountPatch(chainEnabled, zeroInterestInstallments, chainReturnUri, webhookUri, metadataExportKeys);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountPatch: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\ApiAccountApi();
$chainEnabled = true; // Boolean | 
$zeroInterestInstallments = true; // Boolean | 
$chainReturnUri = chainReturnUri_example; // String | 
$webhookUri = webhookUri_example; // String | 
$metadataExportKeys = ; // account_metadata_export_keys | 

try {
    $result = $api_instance->accountPatch($chainEnabled, $zeroInterestInstallments, $chainReturnUri, $webhookUri, $metadataExportKeys);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountPatch: ', $e->getMessage(), PHP_EOL;
}
?>

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

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $chainEnabled = true; # Boolean | 
my $zeroInterestInstallments = true; # Boolean | 
my $chainReturnUri = chainReturnUri_example; # String | 
my $webhookUri = webhookUri_example; # String | 
my $metadataExportKeys = ; # account_metadata_export_keys | 

eval { 
    my $result = $api_instance->accountPatch(chainEnabled => $chainEnabled, zeroInterestInstallments => $zeroInterestInstallments, chainReturnUri => $chainReturnUri, webhookUri => $webhookUri, metadataExportKeys => $metadataExportKeys);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountPatch: $@\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.AccountApi()
chainEnabled = true # Boolean |  (optional)
zeroInterestInstallments = true # Boolean |  (optional)
chainReturnUri = chainReturnUri_example # String |  (optional)
webhookUri = webhookUri_example # String |  (optional)
metadataExportKeys =  # account_metadata_export_keys |  (optional)

try: 
    api_response = api_instance.account_patch(chainEnabled=chainEnabled, zeroInterestInstallments=zeroInterestInstallments, chainReturnUri=chainReturnUri, webhookUri=webhookUri, metadataExportKeys=metadataExportKeys)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountPatch: %s\n" % e)

Parameters

Name	Description
chain_enabled	Boolean
zero_interest_installments	Boolean
chain_return_uri	String (uri)
webhook_uri	String (uri)
metadata_export_keys	account_metadata_export_keys

Responses

Status: 200

 {
  "object": {
    "pattern": "account",
    "type": "string",
    "default": "account"
  },
  "id": {
    "pattern": "account_[0-9a-z]+",
    "type": "string"
  },
  "team": {
    "pattern": "acct_[0-9a-z]+",
    "type": "string"
  },
  "livemode": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "location": {
    "type": "string"
  },
  "country": {
    "type": "string"
  },
  "currency": {
    "type": "string",
    "format": "currency"
  },
  "email": {
    "type": "string"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  },
  "supported_currencies": {
    "type": "array",
    "items": {
      "type": "string",
      "format": "currency"
    }
  },
  "api_version": {
    "type": "string"
  },
  "auto_activate_recipients": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "chain_enabled": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "zero_interest_installments": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "chain_return_uri": {
    "type": "string",
    "format": "uri"
  },
  "webhook_uri": {
    "type": "string",
    "format": "uri"
  },
  "metadata_export_keys": {
    "type": "object"
  },
  "chaining_allowed": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "last_updated_api_version": {
    "type": "string"
  },
  "transfer_config": {
    "type": "object"
  }
}