Capability

Retrieve Capability

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 Capability

curljavaandroidobjcjavascriptcsharpphpperlpython

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

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

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

public class CapabilityApiExample {

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

import io.swagger.client.api.CapabilityApi;

public class CapabilityApiExample {

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

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

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

var OmiseApi = require('omise_api');

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

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

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

            var apiInstance = new CapabilityApi();

            try
            {
                capability result = apiInstance.capabilityGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CapabilityApi.capabilityGet: " + e.Message );
            }
        }
    }
}

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

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

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

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

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

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

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

Responses

Status: 200

 {
  "object": {
    "pattern": "capability",
    "type": "string",
    "default": "capability"
  },
  "location": {
    "type": "string"
  },
  "banks": {
    "type": "array",
    "items": {
      "type": "string"
    }
  },
  "limits": {
    "type": "object",
    "properties": {
      "charge_amount": {
        "type": "object",
        "properties": {
          "max": {
            "type": "integer"
          },
          "min": {
            "type": "integer"
          }
        }
      },
      "transfer_amount": {
        "type": "object",
        "properties": {
          "max": {
            "type": "integer"
          },
          "min": {
            "type": "integer"
          }
        }
      },
      "installment_amount": {
        "type": "object",
        "properties": {
          "min": {
            "type": "integer"
          }
        }
      }
    }
  },
  "payment_methods": {
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "object": {
          "pattern": "payment_method",
          "type": "string",
          "default": "payment_method"
        },
        "name": {
          "type": "string"
        },
        "currencies": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "currency"
          }
        },
        "card_brands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "installment_terms": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "loan_installment_terms": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        },
        "banks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "provider": {
          "type": "string"
        }
      }
    }
  },
  "country": {
    "type": "string"
  },
  "tokenization_methods": {
    "type": "array",
    "items": {
      "type": "string"
    }
  },
  "zero_interest_installments": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  }
}