Omise

https://docs.omise.co/en/
Admin
Omise is a PCI-certified payment gateway offering an intuitive REST API and management dashboard for...
Tokens:468,530
Snippets:2,801
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### List all recipients with GET /recipients

Source: https://docs.omise.co/en/recipients-api/international

List all recipients using the GET /recipients endpoint. Each language example shows the required client setup and the call to retrieve the recipient list. The Go example includes pagination parameters (offset and limit) and error handling.

```curl
curl https://api.omise.co/recipients \
  -u $OMISE_SECRET_KEY:
```

```php
<?php

$recipient = OmiseRecipient::retrieve();
```

```node.js
const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const recp = await omise.recipients.list();
console.log(recp);
```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

recipients = Omise::Recipient.list
```

```C#
var recipients = await Client.Recipients.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"total recipients: {recipients.Total}");
```

```java
Request<ScopedList<Recipient>> request = new Recipient.ListRequestBuilder().build();
ScopedList<Recipient> recipients = client().sendRequest(request);

System.out.printf("Total no. of recipients: %d", recipients.getTotal());
```

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

recipients = omise.Recipient.retrieve()
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.RecipientList{}

err := client.Do(result, &operations.ListRecipients{
	operations.List{
		Offset: 100,
		Limit:  20,
	},
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Recipient.list
```

--------------------------------

### Create a charge with cURL and view example response

Source: https://docs.omise.co/en/paynext-installment-jumpapp/international

Creates a charge using the source ID from Step 1. Replace $OMISE_SECRET_KEY with your test secret key and $SOURCE_ID with the source id. The response shows a pending charge with an authorize_uri for redirecting the customer to TrueMoney Wallet authorisation; expires_at is 7 days after creation for PayNext Extra Installment.

```bash
curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=500000" \
  -d "currency=THB" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

```

```json
{
  "object": "charge",
  "id": "chrg_test_601oytlxd07w48h4paq",
  "location": "/charges/chrg_test_601oytlxd07w48h4paq",
  "amount": 500000,
  "currency": "THB",
  "funding_currency": "THB",
  "funding_amount": 500000,
  "net": 480470,
  "fee": 18250,
  "fee_vat": 1280,
  "interest": 0,
  "interest_vat": 0,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": "0.0",
    "fee_rate": "3.65",
    "vat_rate": "7.0"
  },
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/payments/pay2_test_601oytlz0xfm33yubdb/authorize",
  "return_uri": "http://example.com/orders/345678/complete",
  "source": {
    "object": "source",
    "id": "src_test_601oyt8hdkdx8qoy4n9",
    "livemode": false,
    "amount": 500000,
    "currency": "THB",
    "flow": "app_redirect",
    "type": "installment_paynext_extra_jumpapp",
    "charge_status": "pending",
    "provider_references": {
      "reference_number_1": "4Nv0Qf0VJZ89KueL",
      "reference_number_2": null
    }
  },
  "authorized": false,
  "capturable": false,
  "capture": true,
  "paid": false,
  "expired": false,
  "reversed": false,
  "reversible": false,
  "refundable": false,
  "partially_refundable": false,
  "disputable": false,
  "voided": false,
  "can_perform_void": false,
  "livemode": false,
  "created_at": "2024-06-11T01:54:41Z",
  "paid_at": null,
  "expires_at": "2024-06-18T01:54:41Z"
}

```

--------------------------------

### List all charges with curl and SDKs

Source: https://docs.omise.co/en/charges-api/international

List all charges using the GET /charges endpoint. The curl example uses the OMISE_SECRET_KEY environment variable. The other examples use the respective Omise SDKs (PHP, Node.js, Ruby, C#, Java, Python, Go, Elixir) with test secret keys. The Go example sets limit to 100 and from to one hour ago.

```curl
curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY:
```

```php
<?php

$charges = OmiseCharge::retrieve();
```

```node.js
const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const charge = await omise.charges.list();
console.log(charge);
```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

charges = Omise::Charge.list
```

```C#
var charges = await Client.Charges.GetList(order: Ordering.Chronological);
Console.WriteLine($"total charges: {charges.Total}");
```

```java
Request<ScopedList<Charge>> request = new Charge.ListRequestBuilder().build();
ScopedList<Charge> charges = client().sendRequest(request);

System.out.printf("Total no. of charges: %d", charges.getTotal());
```

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

charges = omise.Charge.retrieve()
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.ChargeList{}
err := client.Do(result, &operations.ListCharges{
	operations.List{
		Limit: 100,
		From:  time.Now().Add(-1 * time.Hour),
	},
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Charge.list
```

--------------------------------

### Create a token with a card in multiple languages

Source: https://docs.omise.co/en/tokens-api/international

Create a token with a card in multiple languages. Each example uses the Omise API to create a token with card details. The Omise.js example uses a callback to log the token ID. The Android SDK example uses a RequestListener. The iOS SDK example uses a request task. The curl example uses the vault endpoint. The PHP, Node.js, Ruby, C#, Java, Python, Go, and Elixir examples use their respective SDKs. Note that the Go example also includes a secret key, which is not needed for token creation.

```javascript
Omise.setPublicKey("OMISE_PUBLIC_KEY");

Omise.createToken("card",
                  {
                    "expiration_month": 2,
                    "expiration_year": 2022,
                    "name": "Somchai Prasert",
                    "number": "4242424242424242",
                    "security_code": "123",
                    "street1": "476 Fifth Avenue",
                    "city": "New York",
                    "state": "NY",
                    "postal_code": "10320",
                    "country": "US"
                  },
                  function(statusCode, response) {
                    console.log(response["id"])
                  });
```

```kotlin
private val client = Client("pkey_test_123")

val cardParam = CardParam(
                name = "JOHN Doe",
                number = "4242424242424242",
                expirationMonth = 10,
                expirationYear = 2020,
                securityCode = "123"
                )

val request = Token.CreateTokenRequestBuilder(cardParam).build()

client.send(request, object: RequestListener<Token>{
   override fun onRequestSucceed(model: Token) {
      // you created a token
   }

    override fun onRequestFailed(throwable: Throwable) {
      // something bad happened
    }
})
```

```swift
let tokenParameter = Token.CreateParameter(
    name: "JOHN DOE",
    number: "4242424242424242",
    expirationMonth: 11,
    expirationYear: 2019,
    securityCode: "123"
)

let request = Request<Token>(parameter: tokenParameter)
let requestTask = client.requestTask(with: request, completionHandler: completionHandler)
requestTask.resume()
```

```bash
curl https://vault.omise.co/tokens \
  -u $OMISE_PUBLIC_KEY: \
  -d "card[name]=Somchai Prasert" \
  -d "card[number]=4242424242424242" \
  -d "card[expiration_month]=10" \
  -d "card[expiration_year]=2025" \
  -d "card[city]=Bangkok" \
  -d "card[postal_code]=10320" \
  -d "card[security_code]=123"
```

```php
<?php

$token = OmiseToken::create(array(
  'card' => array(
    'name' => 'Somchai Prasert',
    'number' => '4242424242424242',
    'expiration_month' => 10,
    'expiration_year' => 2022,
    'city' => 'Bangkok',
    'postal_code' => '10320',
    'security_code' => 123
  )
));
```

```javascript
const omise = require('omise')({
  publicKey: 'pkey_test_no1t4tnemucod0e51mo',
});

const token = await omise.tokens.create({
  card: {
    name: 'JOHN DOE',
    city: 'Bangkok',
    postal_code: 10320,
    number: '4242424242424242',
    expiration_month: 2,
    expiration_year: 2027,
    security_code: 123,
  },
});
console.log(token);
```

```ruby
require "omise"

Omise.public_api_key = "pkey_test_4xs8breq3htbkj03d2x"

token = Omise::Token.create(card: {
  name: "Somchai Prasert",
  number: "4242424242424242",
  expiration_month: 10,
  expiration_year: 2022,
  city: "Bangkok",
  postal_code: "10320",
  security_code: 123
})
```

```csharp
var token = await Client.Tokens.Create(new CreateTokenRequest
{
    Name = "John Doe",
    Number = "4242424242424242",
    ExpirationMonth = 10,
    ExpirationYear = 2022,
    SecurityCode = "123",
});

Console.WriteLine($"created token: {token.Id}");
```

```java
Request<Token> request = new Token.CreateRequestBuilder()
        .card(new Card.Create()
                .name("John Doe")
                .number("4242424242424242")
                .expirationMonth(10)
                .expirationYear(2022)
                .city("Casablanca")
                .postalCode("10420")
                .securityCode("123"))
        .build();
Token token = client().sendRequest(request);

System.out.printf("Created token: %s", token.getId());
```

```python
import omise

omise.api_public = "pkey_test_no1t4tnemucod0e51mo"

token = omise.Token.create(
    name="Somchai Prasert",
    number="4242424242424242",
    expiration_month=10,
    expiration_year=2022,
    city="Bangkok",
    postal_code="10320",
    security_code=123,
)
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Card{}

err := client.Do(result, &operations.CreateToken{
	Name:            "Somchai Prasert",
	Number:          "4242424242424242",
	ExpirationMonth: 10,
	ExpirationYear:  2025,

	City:         "Bangkok",
	PostalCode:   "10320",
	SecurityCode: "123",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(public_key: "pkey_test_56bywcp7sk1qselsyqb")

Omise.Token.create(
  card: [
    name:             "Somchai Prasert",
    number:           "4242424242424242",
    expiration_month: 10,
    expiration_year:  2022,
    city:             "Bangkok",
    postal_code:      "10320",
    security_code:    123
  ]
)
```

--------------------------------

### List all transactions with Omise API in multiple languages

Source: https://docs.omise.co/en/transactions-api/international

List all transactions using the Omise API. Each language example shows the required client setup and the call to retrieve transactions. The Go example includes error handling and a limit of 100 records from the last hour.

```curl
curl https://api.omise.co/transactions \
  -u $OMISE_SECRET_KEY:
```

```php
<?php

$transactions = OmiseTransaction::retrieve();
```

```node.js
const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const customer = await omise.transactions.list();
console.log(customer);
```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

transactions = Omise::Transaction.retrieve
```

```C#
var transactions = await Client.Transactions.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"total transactions to-date: {transactions.Total}");
```

```java
Request<ScopedList<Transaction>> request = new Transaction.ListRequestBuilder().build();
ScopedList<Transaction> transactions = client().sendRequest(request);

System.out.printf("Total no. of transactions: %d", transactions.getTotal());
```

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

transactions = omise.Transaction.retrieve()
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.TransactionList{}

err := client.Do(result, &operations.ListTransactions{
	operations.List{
		Limit: 100,
		From:  time.Now().Add(-1 * time.Hour),
	},
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Transaction.list
```

--------------------------------

### Create a source with Go SDK

Source: https://docs.omise.co/en/sources-api/international

Creates a source using the Go SDK. Initializes a client with public and secret keys, performs the CreateSource operation, and logs the result or fatal error.

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Source{}

err := client.Do(result, &operations.CreateSource{
	Amount:   100000,
	Currency: "thb",
	Type:     "bill_payment_tesco_lotus",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

--------------------------------

### Create Charge with Go (Example)

Source: https://docs.omise.co/en/charges-api/international

Creates a charge using the Omise Go client with a card and customer. Uses test keys and logs the result.

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Charge{}
err := client.Do(result, &operations.CreateCharge{
	Amount:      204842, // THB 2,048.42
	Currency:    "thb",
	Description: "example charge.",
	Card:        "card_test_no1t4tnemucod0e51mo",
	Customer:    "cust_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

--------------------------------

### Retrieve a transaction with Omise API in multiple languages

Source: https://docs.omise.co/en/transactions-api/international

Retrieve a transaction by its ID using the Omise API. The endpoint is GET https://api.omise.co/transactions/{id}. Each language example shows the required client setup and the retrieve call, with the transaction ID as a parameter. The curl example uses the OMISE_SECRET_KEY environment variable for authentication.

```curl
curl https://api.omise.co/transactions/trxn_test_5fzo4nqrnop03djdde1 \
  -u $OMISE_SECRET_KEY:
```

```php
<?php

$transactions = OmiseTransaction::retrieve('trxn_test_4xuy2z4w5vmvq4x5pfs');

```

```node.js
const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const customer = await omise.transactions.retrieve('trxn_test_no1t4tnemucod0e51mo');
console.log(customer);

```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

transaction = Omise::Transaction.retrieve("trxn_test_4xuy2z4w5vmvq4x5pfs")

```

```C#
var transactionId = "trxn_test_58fmj4hion95mndc96d";
var transaction = await Client.Transactions.Get(transactionId);
Console.WriteLine($"transaction amount: {transaction.Amount}");

```

```java
Request<Transaction> request =
        new Transaction.GetRequestBuilder("trxn_test_4xuy2z4w5vmvq4x5pfs").build();
Transaction transaction = client().sendRequest(request);

System.out.printf("Transaction amount: %d", transaction.getAmount());

```

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

transaction = omise.Transaction.retrieve("trxn_test_no1t4tnemucod0e51mo")

```

```go
client, _ := omise.NewClient(
	"pkey_test_5no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Transaction{}

err := client.Do(result, &operations.RetrieveTransaction{
	TransactionID: "trxn_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

```

```elixir
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Transaction.retrieve("trxn_test_4xuy2z4w5vmvq4x5pfs")

```

--------------------------------

### OmiseCard.open method example

Source: https://docs.omise.co/en/omise-js/international

Opens the payment form with configuration. Must call configure before open. Handles token/source creation and form closure.

```javascript
OmiseCard.open({
  amount: 10000,
  submitFormTarget: '#checkout-form',
  onCreateTokenSuccess: (nonce) => {
    /* Handler for token or source creation. Use this to submit a form or send an Ajax request to the server. */
  },
  onFormClosed: () => {
    /* Handler for form closure. */
  },
});
```

--------------------------------

### List pending disputes with GET /disputes/pending

Source: https://docs.omise.co/en/disputes-api/international

Retrieve all pending disputes using the GET /disputes/pending endpoint. Each language example shows the required authentication and the method call to list disputes with status 'pending'. The C# example uses ReverseChronological ordering, and the Java example prints the total count.

```curl
curl https://api.omise.co/disputes/pending \
  -u $OMISE_SECRET_KEY:
```

```php
<?php

$disputes = OmiseDispute::retrieve('pending');
```

```node.js
const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const dispute = await omise.disputes.listPending();
console.log(dispute);
```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

disputes = Omise::Dispute.list(status: "pending")
```

```C#
var resource = Client.Disputes.PendingDisputes;
var pendingDisputes = await resource.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"pending disputes: {pendingDisputes.Total}");
```

```java
Request<ScopedList<Dispute>> request = new Dispute.ListRequestBuilder().status(DisputeStatus.Pending).build();
ScopedList<Dispute> disputes = client().sendRequest(request);

System.out.printf("Pending disputes: %d", disputes.getTotal());
```

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

dispute = omise.Dispute.retrieve(status="pending")
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Dispute{}
err := client.Do(result, &operations.ListDisputes{
	State: omise.Pending,
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Dispute.list(status: "pending")
```

--------------------------------

### Monitor bulk creation - curl example

Source: https://docs.omise.co/en/charge-schedule-api/international

Gets the status of a batch creation job using its recurring_id. The example uses job ID 'recurr_test_0000000000000002'.

```bash
curl -X GET api.omise.co/recurring_exports/recurr_test_0000000000000002 \
-u "skey_test_XXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### Example response for PayNext Extra Installment QR source creation

Source: https://docs.omise.co/en/paynext-installment-qr/international

Example response from creating a PayNext Extra Installment QR source. The id field (prefixed src_) is the source identifier used in the next step. installment_term and scannable_code are null at creation; charge_status is unknown until a charge is created.

```json
{
  "object": "source",
  "id": "src_test_601oy3f2u9m8llki4eh",
  "livemode": false,
  "location": "/sources/src_test_601oy3f2u9m8llki4eh",
  "amount": 500000,
  "currency": "THB",
  "flow": "offline",
  "type": "installment_paynext_extra_qr",
  "charge_status": "unknown",
  "created_at": "2024-06-11T01:52:37Z",
  "barcode": null,
  "bank": null,
  "email": null,
  "installment_term": null,
  "ip": "35.198.236.178",
  "absorption_type": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "provider_references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "zero_interest_installments": null,
  "receipt_amount": null,
  "discounts": [],
  "promotion_code": null
}
```

--------------------------------

### OmiseCard.configureButton method example

Source: https://docs.omise.co/en/omise-js/international

Configures buttons with specific payment details. Multiple buttons can be configured with different amounts and currencies.

```javascript
OmiseCard.configure({
  publicKey: 'OMISE_PUBLIC_KEY'
});

OmiseCard.configureButton('#checkout-button', {
  amount: 3000,
  currency: 'USD',
  buttonLabel: 'Pay 30 USD'
});

OmiseCard.configureButton('#checkout-button-alt', {
  amount: 100000,
  currency: 'THB',
  buttonLabel: 'Pay 1000 THB'
});
```

--------------------------------

### Create a source with Node.js SDK

Source: https://docs.omise.co/en/sources-api/international

Creates a source using the Node.js SDK. Initializes the client with a public key, then calls omise.sources.create and logs the created source ID or an error.

```javascript
'use strict';

exports.__esModule = true;
var omise = require('../index')({
  'publicKey': 'pkey_test_56bywcp7sk1qselsyqb'
});

var source = {
  'type':     'internet_banking_bbl',
  'amount':   500000,
  'currency': 'thb'
};

omise.sources.create(source).then(function(resSource) {
  console.log(`created source: ${resSource.id}`);
}).catch(function(err) {
  console.log(err);
});
```

--------------------------------

### List all dispute documents with curl and Ruby

Source: https://docs.omise.co/en/documents-api/international

Lists all documents belonging to a dispute. The curl example uses a GET request, while the Ruby example retrieves the dispute and accesses its `documents` collection.

```curl
curl https://api.omise.co/disputes/dspt_test_5g5ih3pybo7v4wwrbjw/documents \
  -u $OMISE_SECRET_KEY:
```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

dispute   = Omise::Dispute.retrieve("dspt_test_4zgf15h89w8t775kcm8")
documents = dispute.documents
```

--------------------------------

### Create a source with Java SDK

Source: https://docs.omise.co/en/sources-api/international

Creates a source using the Java SDK. Builds a Source.Create with type, amount, and currency, then prints the created source ID.

```java
Client client = new Client("pkey_test_56bywcp7sk1qselsyqb");
Source source = client.sources().create(new Source.Create()
        .type(SourceType.InternetBankingScb)
        .amount(10000)
        .currency("thb"));
System.out.println("created source: " + source.getId());
```

--------------------------------

### Example response for creating a PayNext Extra Installment source

Source: https://docs.omise.co/en/paynext-installment-jumpapp/international

Example JSON response from the source creation request. The 'id' field (prefixed 'src_') is the source identifier used in the next step.

```json
{
  "object": "source",
  "id": "src_test_601oytj0iy7dtjgnme4",
  "livemode": false,
  "location": "/sources/src_test_601oytj0iy7dtjgnme4",
  "amount": 500000,
  "currency": "THB",
  "flow": "app_redirect",
  "type": "installment_paynext_extra_jumpapp",
  "charge_status": "unknown",
  "created_at": "2024-06-11T01:54:41Z",
  "barcode": null,
  "bank": null,
  "email": null,
  "installment_term": null,
  "ip": "35.198.236.178",
  "absorption_type": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "provider_references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "zero_interest_installments": null,
  "receipt_amount": null,
  "discounts": [],
  "promotion_code": null
}
```

--------------------------------

### Capability API JSON Response Example

Source: https://docs.omise.co/en/capability-api/international

Example JSON response from the Capability API. It shows the account's supported banks, charge/transfer/installment limits, and available payment methods with their currencies, card brands, and installment terms.

```json
{
  "object": "capability",
  "location": "/capability",
  "banks": [
    "test",
    "bbl",
    "kbank",
    "rbs",
    "ktb",
    "jpm",
    "mufg",
    "ttb",
    "scb",
    "citi",
    "smbc",
    "sc",
    "cimb",
    "uob",
    "bay",
    "mega",
    "boa",
    "cacib",
    "gsb",
    "hsbc",
    "db",
    "ghb",
    "baac",
    "mb",
    "bnp",
    "ibank",
    "tisco",
    "kk",
    "icbc",
    "tcrb",
    "lhb"
  ],
  "limits": {
    "charge_amount": {
      "max": 15000000,
      "min": 2000
    },
    "transfer_amount": {
      "max": 5000000000,
      "min": 3000
    },
    "installment_amount": {
      "min": 200000
    }
  },
  "payment_methods": [
    {
      "object": "payment_method",
      "name": "card",
      "currencies": [
        "THB",
        "JPY",
        "USD",
        "EUR",
        "GBP",
        "SGD",
        "AUD",
        "CHF",
        "CNY",
        "DKK",
        "HKD"
      ],
      "card_brands": [
        "JCB",
        "Visa",
        "MasterCard"
      ],
      "installment_terms": null,
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "internet_banking_bay",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": null,
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "internet_banking_bbl",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": null,
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "alipay",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": null,
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "installment_bay",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        6,
        9,
        10
      ],
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "installment_kbank",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        6,
        10
      ],
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "installment_ktc",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10
      ],
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "installment_bbl",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        4,
        6,
        8,
        9,
        10
      ],
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "installment_first_choice",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": [
        3,
        4,
        6,
        9,
        10,
        12,
        18,
        24,
        36
      ],
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "bill_payment_tesco_lotus",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": null,
      "banks": [],
      "provider": null
    },
    {
      "object": "payment_method",
      "name": "barcode_alipay",
      "currencies": [
        "THB"
      ],
      "card_brands": null,
      "installment_terms": null,
      "banks": [],
      "provider": null
    }
  ]
}
```

--------------------------------

### Create a charge from a source in Java

Source: https://docs.omise.co/en/charges-api/international

Java example that creates a source and then uses it to create a charge. The source is created with type InternetBankingBay, amount 10000, and currency THB. The charge uses the source ID and a return URI.

```java
Request<Source> sourceRequest = new Source.CreateRequestBuilder()
        .type(SourceType.InternetBankingBay)
        .amount(10000)
        .currency("THB")
        .build();
Source source = client.sendRequest(sourceRequest);

Request<Charge> createChargeRequest = new Charge.CreateRequestBuilder()
        .source(source.getId())
        .amount(10000)
        .currency("THB")
        .returnUri("http://example.com")
        .build();
Charge charge = client.sendRequest(createChargeRequest);

System.out.printf("Created charge: " + charge.getId());
```

--------------------------------

### List all cards for a customer (GET /customers/{id}/cards)

Source: https://docs.omise.co/en/cards-api/international

List all cards for a customer using the Omise API. The curl example uses the secret key for authentication; the other examples use the respective SDKs to retrieve the customer and call the cards listing method. Each example uses a test customer ID and secret key.

```curl
curl https://api.omise.co/customers/cust_test_5g0221fe8iwtayocgja/cards \
  -u $OMISE_SECRET_KEY:
```

```php
<?php

$customer = OmiseCustomer::retrieve('cust_test_4ybb9ymhoi7ju6wuizb');
$cards = $customer->getCards();
```

```node.js
const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const card = await omise.customers.listCards('cust_test_no1t4tnemucod0e51mo');
console.log(card);
```

```ruby
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

customer = Omise::Customer.retrieve("cust_test_4xsjvylia03ur542vn6")
cards = customer.cards
```

```C#
var customerId = "cust_test_566l662pnj240tgz61k";
var cards = await Client.Customer(customerId).Cards.GetList();
foreach (var card in cards)
{
    Console.WriteLine($"card: {card.Id} ({card.LastDigits})");
}
```

```java
Request<ScopedList<Card>> request =
        new Card.ListRequestBuilder("cust_test_4xsjvylia03ur542vn6").build();
ScopedList<Card> cards = client().sendRequest(request);

System.out.printf("Total no. of cards: %d", cards.getTotal());
```

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

customer = omise.Customer.retrieve("cust_test_no1t4tnemucod0e51mo")
cards = customer.cards
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.CardList{}
err := client.Do(result, &operations.ListCards{
	CustomerID: "cust_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Customer.list_cards("cust_test_4xsjvylia03ur542vn6")
```

--------------------------------

### Create a charge schedule (C#)

Source: https://docs.omise.co/en/schedules-api/international

Creates a monthly charge schedule for a customer using the Omise .NET client. The schedule runs on the second Monday of each month, charging 2000 in THB. Requires the Omise .NET SDK and a client instance.

```csharp
var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 1,
    Period = SchedulePeriod.Month,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        WeekdayOfMonth = "2nd_monday"
    },
    Charge = new ChargeScheduling
    {
        Amount = 2000,
        Currency = "thb",
        Customer = "cust_test_59gbtlbjldnc8651pmp",
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");
```

--------------------------------

### Retrieve a card with C#

Source: https://docs.omise.co/en/cards-api/international

Retrieve a card using the Omise C# library. The example uses the Client.Customer method to get the customer, then retrieves the card and prints the last digits.

```csharp
var customerId = "cust_test_566l662pnj240tgz61k";
var cardId = "card_test_566l661ty3h314lpl9e";
var card = await Client.Customer(customerId).Cards.Get(cardId);
Console.WriteLine($"last digits: {card.LastDigits}");
```

--------------------------------

### List Transfer Schedules - Go

Source: https://docs.omise.co/en/transfer-schedules-api/international

Go example using the Omise client to list transfer schedules with a limit and from time.

```go
client, _ := omise.NewClient(
	"pkey_test_5no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.ScheduleList{}

err := client.Do(result, &operations.ListTransferSchedules{
	List: operations.List{
		Limit: 100,
		From:  time.Now().Add(-1 * time.Hour),
	},
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

--------------------------------

### List Transfer Schedules - Java

Source: https://docs.omise.co/en/transfer-schedules-api/international

Java example using the Omise SDK to list transfer schedules.

```java
Request<ScopedList<Schedule>> request = new Schedule.TransferScheduleListRequestBuilder().build();
ScopedList<Schedule> schedules = client().sendRequest(request);

System.out.printf("Total no. of transfer schedules: %d", schedules.getTotal());
```

--------------------------------

### Response for retrieving all links

Source: https://docs.omise.co/en/payment-links-apis/international

Example response for the GET /external/:team_id/links endpoint. Shows the structure of a Link object and the total count. A 404 error is returned if the team ID doesn't exist.

```json
{
  "links": [
    {
      "id": 20395,
      "name": "Tiger Paw Bags",
      "state": "active",
      "amount": 200000,
      "currency": "THB",
      "multiple_usage": true,
      "additional": null,
      "expired_at": null,
      "features": {
        "Type": "School Bags",
        "Size": "Medium"
      },
      "transaction_id": "Vb9LdXe2Ko",
      "url": "https://linksplus.omise.co/Vb9LdXe2Ko",
      "template_id": 4108,
      "kind": null,
      "created_at": "2026-09-28T10:58:37.429Z",
      "updated_at": "2026-09-28T10:58:37.429Z"
    }
  ],
  "total": 1
}

```

--------------------------------

### Create a source with Python SDK

Source: https://docs.omise.co/en/sources-api/international

Creates a source using the Python SDK. Sets the API secret and version, then calls omise.Source.create with amount, currency, and type.

```python
import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"
omise.api_version = "2017-11-02"

source = omise.Source.create(
    amount=100000, currency="thb", type="bill_payment_tesco_lotus"
)
```

--------------------------------

### Retrieve a token with Omise API

Source: https://docs.omise.co/en/tokens-api/international

Retrieve a token by its ID using the Omise API. The endpoint accepts only public key authentication. Each example shows the required setup and call for the respective language.

```bash
curl https://vault.omise.co/tokens/tokn_test_5g5mep9yrko3vx2f0hx \
  -u $OMISE_PUBLIC_KEY:
```

```php
<?php

$token = OmiseToken::retrieve('tokn_test_4xs9408a642a1htto8z');
```

```javascript
const omise = require('omise')({
  publicKey: 'pkey_test_no1t4tnemucod0e51mo',
});

const token = await omise.tokens.retrieve('tokn_test_5v3exp0j9e5s7oicmzs');
console.log(token);
```

```ruby
require "omise"

Omise.public_api_key = "pkey_test_4xs8breq3htbkj03d2x"

token = Omise::Token.retrieve("tokn_test_4xs9408a642a1htto8z")
```

```csharp
var tokenId = RetrieveTokenId();
var token = await Client.Tokens.Get(tokenId);
Console.WriteLine($"token already used? {token.Used}");
```

```java
Request<Token> request = new Token.GetRequestBuilder("tokn_test_4xs9408a642a1htto8z").build();
Token token = client().sendRequest(request);

System.out.printf("token last digits: %s", token.getCard().getLastDigits());
```

```python
import omise

omise.api_public = "pkey_test_no1t4tnemucod0e51mo"

token = omise.Token.retrieve("tokn_test_no1t4tnemucod0e51mo")
```

```go
client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Token{}

err := client.Do(result, &operations.RetrieveToken{
	ID: "tokn_test_no1t4tnemucod0e51mo",
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)
```

```elixir
Omise.configure(public_key: "pkey_test_56bywcp7sk1qselsyqb")

Omise.Token.retrieve("tokn_test_4xs9408a642a1htto8z")
```
Tokens:
Raw