Omise PHP Library

https://github.com/omise/omise-php
Admin
Omise PHP Library is a PHP library designed specifically to connect with the Opn Payments API.
Tokens:85,460
Snippets:733
Trust Score:8.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Shell: Run PHPUnit tests

Source: https://github.com/omise/omise-php/blob/master/README.md

Copies the environment example file and runs the test suite with make test. Requires PHPUnit to be installed locally.

```shell
cp .env.example .env
make test
```

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

### Define Omise constants (README setup)

Source: https://github.com/omise/omise-php/blob/master/_autodocs/configuration.md

Typical setup from the README: defines the public key, secret key, and API version constants.

```php
define('OMISE_PUBLIC_KEY', 'pkey_test_***');
define('OMISE_SECRET_KEY', 'skey_test_***');
define('OMISE_API_VERSION', '2019-05-29');
```

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

### Install Omise-PHP with Composer

Source: https://github.com/omise/omise-php/blob/master/README.md

Runs the Composer install command to install the Omise-PHP library. This command should be executed after creating the composer.json file.

```bash
php composer.phar install
```

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

### OmiseOccurrenceList usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves a schedule, gets its occurrences, iterates over them, and retrieves the first occurrence.

```php
$schedule = OmiseSchedule::retrieve('schd_test_***');
$occurrences = $schedule->occurrences(['limit' => 5]);

foreach ($occurrences['data'] as $occurrence) {
    echo $occurrence['id'];
}

$first = $occurrences->retrieve($occurrences['data'][0]['id']);
echo $first['status'];
```

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

### start method

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Posts accumulated attributes to the API and returns an OmiseSchedule instance.

```php
public function start()
```

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

### Create and retrieve a charge schedule

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-schedule.md

Example from examples/OmiseSchedule.php showing how to create a charge schedule with explicit keys and then retrieve it.

```php
$createResult = OmiseSchedule::create([
    'every' => 15,
    'period' => 'day',
    'start_date' => '2025-05-01',
    'end_date' => '2025-05-31',
    'charge[customer]' => $customer,
    'charge[amount]' => 100000,
    'charge[description]' => 'Testing schedule',
], OMISE_PUBLIC_KEY, OMISE_SECRET_KEY);

echo $createResult['id'];

$result = OmiseSchedule::retrieve($createResult['id'], OMISE_PUBLIC_KEY, OMISE_SECRET_KEY);
echo $result['id'];
```

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

### OmiseScheduler::start

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Starts the schedule by creating it via the API. Returns the created schedule object.

```APIDOC
## OmiseScheduler::start

### Description
Starts the schedule by creating it via the API. Returns the created schedule object.

### Method
OmiseScheduler::start

### Return Value
- **OmiseSchedule** - The created schedule object.

### Usage Example
```php
$schedule = $scheduler->start();
echo $schedule['id'];
```
```

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

### OmiseBalance usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves the balance and echoes the available amount and currency.

```php
$balance = OmiseBalance::retrieve();
echo $balance['available'];   // available balance in subunits
echo $balance['currency'];    // 'thb'
```

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

### OmiseEvent usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves an event and accesses its type and data.

```php
$event = OmiseEvent::retrieve('evnt_test_***');
echo $event['type'];  // e.g. 'charge.created'
echo $event['data']['id'];
```

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

### OmiseReceipt usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves a receipt and outputs its number and charge.

```php
$receipt = OmiseReceipt::retrieve('rcpt_test_***');
echo $receipt['number'];
echo $receipt['charge'];
```

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

### start

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Submits the accumulated schedule attributes to the API and returns an OmiseSchedule object.

```APIDOC
## start

### Description
Submits the accumulated schedule attributes to the API and returns an OmiseSchedule object.

### Method
Builder method

### Signature
```php
public function start()
```

### Parameters
None.

### Returns
`OmiseSchedule` - The created schedule object.
```

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

### OmiseChain usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves a chain by ID and revokes it, catching exceptions.

```php
$chain = OmiseChain::retrieve('chain_test_***');

try {
    $chain->revoke(); // revoke a sub-merchant chain
    echo 'Chain revoked';
} catch (OmiseException $e) {
    echo $e->getMessage();
}
```

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

### schedule

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-charge.md

Creates a charge schedule with the given parameters. The schedule is created lazily when `->start()` is called.

```APIDOC
## [POST] /charges/schedules

### Description
Creates a charge schedule with the given parameters. The schedule is created lazily when `->start()` is called.

### Method
POST

### Endpoint
`{OMISE_API_URL}charges/schedules` (via `OmiseScheduler`)

### Parameters
#### Request Body
- **params** (array) - Required - Initial schedule attributes.
- **publickey** (string / null) - Optional - Public key override.
- **secretkey** (string / null) - Optional - Secret key override.

### Request Example
```json
{
  "amount": 1000,
  "currency": "thb",
  "frequency": "monthly"
}
```

### Response
#### Success Response (200)
- **OmiseScheduler** - The scheduler object; call `->start()` to create the schedule.

### Error Handling
Throws `Exception|OmiseException` on failure.
```

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

### OmiseTransaction usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves a transaction and outputs its amount, currency, and status.

```php
$transaction = OmiseTransaction::retrieve('trxn_test_***');
echo $transaction['amount'];
echo $transaction['currency'];
echo $transaction['status']; // 'successful' / 'failed' / ...
```

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

### OmiseForex usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves forex data for JPY and accesses base and rates, then reloads.

```php
$forex = OmiseForex::retrieve('jpy');
echo $forex['base'];          // 'jpy'
echo $forex['rates']['thb'];  // exchange rate
$forex->reload();             // refreshes using the 'base' attribute
```

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

### startDate

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Sets the start date of the schedule. Merges the 'start_date' attribute.

```APIDOC
## startDate

### Description
Sets the start date of the schedule. Merges the 'start_date' attribute.

### Method
Builder method

### Signature
```php
public function startDate($date)
```

### Parameters
- **$date** (string) - Required - ISO 8601 date (`YYYY-MM-DD`).

### Returns
`self` (OmiseScheduler) - Enables fluent chaining.
```

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

### Create a token from card data

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-source-token.md

Development-only example from examples/OmiseCharge.php. Creates a token with card details and echoes the token ID.

```php
$token = OmiseToken::create([
    'card' => [
        'name' => 'Omise',
        'number' => '4242424242424242',
        'expiration_month' => 10,
        'expiration_year' => 2042,
        'city' => 'Bangkok',
        'postal_code' => '10320',
        'security_code' => 123
    ]
]);

echo $token['id']; // tok_test_...
```

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

### Refund a charge and list refunds

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-refund.md

Example from examples/OmiseCharge.php: retrieves a charge, creates a refund, lists refunds with query options, and retrieves a specific refund.

```php
$chargeFetched = OmiseCharge::retrieve('chrg_test_***');

// Create a refund through the charge's refund list.
$chargeRefund = $chargeFetched->refunds()->create(['amount' => 100000]);
echo $chargeRefund['id'];

// List refunds (embedded), or fetch with query options:
$refundList = $chargeFetched->refunds(['from' => '2025-01-01']);
$refund = $refundList->retrieve($chargeRefund['id']);
echo $refund['amount'];
```

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

### Create, update, and list schedules usage

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-recipient.md

Shows how to create a recipient, update it, and retrieve its transfer schedules. The example includes a comment about bank account attributes per Omise API documentation.

```php
$recipient = OmiseRecipient::create([
    'name' => 'John Doe',
    'email' => 'john@example.com',
    'type' => 'individual',
    // bank account attributes per the Omise API documentation
]);

echo $recipient['id'];

$recipient->update(['name' => 'John Doe Jr.']);

$schedules = $recipient->schedules(['limit' => 10]);
$schedule = $schedules->retrieve($schedules['data'][0]['id']);
```

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

### retrieve

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Retrieves a customer by ID, or fetches the list of customers when no ID is provided. This method issues a GET request to the /customers endpoint.

```APIDOC
## [GET] /customers/{id}

### Description
Retrieves a customer by ID, or fetches the list of customers when no ID is provided.

### Method
GET

### Endpoint
`{OMISE_API_URL}customers/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - Customer ID (`cust_...`); empty fetches the list.

### Response
#### Success Response (200)
- **OmiseCustomer** - The customer object.

#### Error Response
- **Exception|OmiseException** - Thrown on error.

```

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

### OmiseOccurrence usage example

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Retrieves an occurrence and prints its status. Status can be 'scheduled', 'successful', or 'failed'.

```php
$occurrence = OmiseOccurrence::retrieve('occr_test_***');
echo $occurrence['status']; // 'scheduled' / 'successful' / 'failed'
```

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

### OmiseCharge::schedule static method

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-charge.md

Static method to create a charge schedule. Returns OmiseScheduler; call ->start() to create the schedule.

```php
public static function schedule($params, $publickey = null, $secretkey = null)
```

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

### Daily schedule with every() and days()

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Creates a daily OmiseScheduler for a charge, using every(15) and days(). Starts the schedule and echoes the schedule ID.

```php
$scheduler = new OmiseScheduler('charge', [
        'charge[customer]' => 'cust_test_***',
        'charge[amount]' => 100000,
        'charge[description]' => 'Daily coffee allowance',
    ])
    ->every(15)
    ->days();

$schedule = $scheduler->start();
echo $schedule['id'];
```

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

### PHP: Retrieve account information

Source: https://github.com/omise/omise-php/blob/master/README.md

Retrieves the account information using OmiseAccount::retrieve() and prints the account email. This example assumes the API keys are already defined.

```php
$account = OmiseAccount::retrieve();

echo $account['email']; // your email will be printed on a screen.
```

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

### OmiseCharge create, update, reload flow

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-api-resource.md

Typical create/update flow using public wrappers. The update() method triggers g_update → PATCH /charges/{id}, and reload() triggers g_reload → GET /charges/{id}. These protected methods are normally not called directly.

```php
$charge = OmiseCharge::create([
    'amount' => 100000,
    'currency' => 'thb',
    'card' => 'tok_test_***',
]);

// g_update → PATCH /charges/{id}
$charge->update(['description' => 'Updated description']);

// g_reload → GET /charges/{id}
$charge->reload();

```

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

### Create customer, list cards, and delete

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Shows how to create a customer with a card, retrieve its cards, update a card, fetch filtered cards, and delete the customer. Includes checking if the customer is destroyed.

```php
$customer = OmiseCustomer::create([
    'email' => 'john.doe@example.com',
    'description' => 'John Doe (id: 30)',
    'card' => 'tok_test_***',
]);

echo $customer['id'];

// List cards — uses the embedded 'cards' attribute.
$cardList = $customer->cards();
$card = $cardList->retrieve($customer['cards']['data'][0]['id']);
$card->update(['expiration_month' => 12, 'expiration_year' => 2030]);

// Fetch with filters (issues a GET /customers/{id}/cards?limit=...)
$filtered = $customer->cards(['limit' => 5]);

$customer->destroy();
if (OmiseCustomer::isDestroyed()) {
    echo 'Customer deleted';
}
```

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

### Load Omise-PHP via Composer autoload

Source: https://github.com/omise/omise-php/blob/master/README.md

Includes the Composer-generated autoload file to load the Omise-PHP library. Add this line to your PHP script after running composer install.

```php
require_once dirname(__FILE__).'/vendor/autoload.php';
```

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

### Schedule a recurring charge

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-charge.md

Creates a monthly recurring charge schedule starting on the first Monday of the month from 2025-06-01, then starts it and prints the schedule ID.

```php
$scheduler = OmiseCharge::schedule([
        'charge[customer]' => 'cust_test_***',
        'charge[amount]' => 100000,
        'charge[description]' => 'Monthly subscription',
    ])
    ->every(1)
    ->month('first_monday')
    ->startDate('2025-06-01');

$schedule = $scheduler->start();
echo $schedule['id'];
```

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

### create

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Creates a new customer with the given attributes. This method issues a POST request to the /customers endpoint.

```APIDOC
## [POST] /customers

### Description
Creates a new customer with the given attributes.

### Method
POST

### Endpoint
`{OMISE_API_URL}customers`

### Parameters
#### Request Body
- **params** (array) - Required - Customer attributes (e.g. `email`, `description`, `card`).

### Response
#### Success Response (200)
- **OmiseCustomer** - The created customer object.

#### Error Response
- **Exception|OmiseException** - Thrown on error.

```

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

### filterPaymentMethodChargeAmount

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-capability.md

Creates a filter closure that checks if a payment method supports the given charge amount. For installment methods, it checks against installment limits; otherwise, against charge limits.

```APIDOC
## filterPaymentMethodChargeAmount

### Description
Creates a filter closure that checks if a payment method supports the given charge amount. For installment methods, it checks against installment limits; otherwise, against charge limits.

### Method
N/A (filter function)

### Endpoint
N/A

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
No request body required.

### Response
#### Success Response (200)
- **closure** - A function that takes a payment method object and returns true if the amount is within the applicable limits.

#### Response Example
No response body.
```

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

### Schedule recurring transfers

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-transfer.md

Creates a schedule for recurring transfers using OmiseTransfer::schedule and starts it.

```php
$scheduler = OmiseTransfer::schedule([
        'transfer[recipient]' => 'recp_test_***',
        'transfer[amount]' => 100000,
    ])
    ->every(1)
    ->month('first_monday')
    ->startDate('2025-06-01');

$schedule = $scheduler->start();
```

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

### OmiseScheduler::startDate

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Sets the start date for the schedule. This method is chainable and returns the scheduler instance.

```APIDOC
## OmiseScheduler::startDate

### Description
Sets the start date for the schedule. This method is chainable and returns the scheduler instance.

### Method
OmiseScheduler::startDate

### Parameters
- **$date** (string) - Required - The start date in YYYY-MM-DD format.

### Return Value
- **OmiseScheduler** - The scheduler instance for chaining.

### Usage Example
```php
$scheduler->startDate('2025-06-01');
```
```

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

### startDate method

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Sets start_date attribute to the given ISO 8601 date. Returns self.

```php
public function startDate($date)
```

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

### schedule

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-transfer.md

Creates a scheduler for recurring transfers. Returns an OmiseScheduler instance; call `->start()` to create the schedule.

```APIDOC
## schedule

### Description
Creates a scheduler for recurring transfers. Returns an OmiseScheduler instance; call `->start()` to create the schedule.

### Method
POST

### Endpoint
`{OMISE_API_URL}transfers/schedules` (via `OmiseScheduler`)

### Parameters
#### Request Body
- `params` (mixed/array) - Required - Transfer attributes for the schedule (e.g., `transfer[recipient]`, `transfer[amount]`).

#### Query Parameters
- `publickey` (string) - Optional - Public key override.
- `secretkey` (string) - Optional - Secret key override.

### Response
#### Success Response (200)
- Returns `OmiseScheduler` instance.
```

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

### Exception message for missing OMISE_PUBLIC_KEY

Source: https://github.com/omise/omise-php/blob/master/_autodocs/configuration.md

Thrown by the constructor when the required constant is not defined and no explicit key is passed.

```php
Exception('OMISE_PUBLIC_KEY value is undefined. This is required for authentication')
```

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

### reload

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Reloads the customer data from the API. This method issues a GET request to the /customers/{id} endpoint.

```APIDOC
## [GET] /customers/{id}

### Description
Reloads the customer data from the API.

### Method
GET

### Endpoint
`{OMISE_API_URL}customers/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - Customer ID.

### Response
#### Success Response (200)
- **void** - No return value.

```

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

### OmiseCard::reload

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-card.md

Reloads the card data from the API. Sends a GET request to the card endpoint.

```APIDOC
## OmiseCard::reload

### Description
Reloads the card data from the API. Sends a GET request to the card endpoint.

### Method
GET

### Endpoint
`{OMISE_API_URL}customers/{customerID}/cards/{id}`

### Parameters
None.

### Returns
`void`
```

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

### GET occurrences/{id}

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a specific occurrence by ID. Requires secret authentication.

```APIDOC
## [GET] occurrences/{id}

### Description
Retrieves a specific occurrence by ID.

### Method
GET

### Endpoint
`{OMISE_API_URL}occurrences/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the occurrence to retrieve.

### Response
#### Success Response (200)
- **id** (string) - Occurrence ID.
- **status** (string) - Status of the occurrence.

#### Response Example
```json
{
  "id": "occ_test_123",
  "status": "scheduled"
}
```
```

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

### schedules

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Lists schedules associated with a customer. This method issues a GET request to the /customers/{id}/schedules endpoint.

```APIDOC
## [GET] /customers/{id}/schedules

### Description
Lists schedules associated with a customer.

### Method
GET

### Endpoint
`{OMISE_API_URL}customers/{id}/schedules`

### Parameters
#### Path Parameters
- **id** (string) - Required - Customer ID.

#### Query Parameters
- **options** (array|string) - Optional - Query parameters; arrays are serialized with `http_build_query`.

### Response
#### Success Response (200)
- **OmiseScheduleList|null** - List of schedules, or null if not available.

```

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

### cards

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Lists cards associated with a customer. This method issues a GET request to the /customers/{id}/cards endpoint.

```APIDOC
## [GET] /customers/{id}/cards

### Description
Lists cards associated with a customer.

### Method
GET

### Endpoint
`{OMISE_API_URL}customers/{id}/cards`

### Parameters
#### Path Parameters
- **id** (string) - Required - Customer ID.

#### Query Parameters
- **options** (array) - Optional - Query parameters for filtering.

### Response
#### Success Response (200)
- **OmiseCardList|null** - List of cards, or null if not available.

```

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

### Usage: Create and accept a dispute

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-dispute.md

Shows how to create a dispute against a charge and then accept it. Uses OmiseCharge::retrieve and OmiseDispute::create with parameters, then calls accept().

```php
$charge = OmiseCharge::retrieve('chrg_test_***');

$dispute = OmiseDispute::create($charge, [
    'amount' => 100000,
    'reason' => 'fraudulent',
    'message' => 'Customer claims they did not make this purchase',
]);

echo $dispute['id'];

// Resolve the dispute by accepting it.
$dispute->accept();
```

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

### Search customers with filters

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Demonstrates searching for customers with a query, filtering by active status, and paginating results.

```php
$search = OmiseCustomer::search('demo')
    ->filter(['active' => true])   // booleans are converted to 'true'/'false' strings
    ->page(1)
    ->per_page(20);

foreach ($search['data'] as $result) {
    echo $result['object'] . ': ' . $result['id'];
}
```

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

### schedules

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-charge.md

Retrieves a list of charge schedules with optional query parameters. This method wraps the GET /charges/schedules endpoint.

```APIDOC
## [GET] /charges/schedules

### Description
Retrieves a list of charge schedules with optional query parameters.

### Method
GET

### Endpoint
`{OMISE_API_URL}charges/schedules?{options}`

### Parameters
#### Query Parameters
- **options** (array) - Optional - Query parameters (e.g. `from`, `to`, `limit`, `offset`); serialized with `http_build_query`.
- **publickey** (string) - Optional - Public key override.
- **secretkey** (string) - Optional - Secret key override.

### Response
#### Success Response (200)
- **OmiseScheduleList** - List of charge schedules.

### Error Handling
Throws `Exception|OmiseException` on failure.
```

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

### GET schedules

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a list of schedules or a specific schedule by ID. Requires secret authentication.

```APIDOC
## GET {OMISE_API_URL}schedules

### Description
Retrieves a list of schedules or a specific schedule by ID. Requires secret authentication.

### Method
GET

### Endpoint
`{OMISE_API_URL}schedules` or `{OMISE_API_URL}schedules/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - The schedule ID to retrieve a specific schedule.

### Response
#### Success Response (200)
- **schedules** (array) - List of schedule objects.

#### Response Example
{
  "schedules": []
}
```

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

### Configure public and secret keys

Source: https://github.com/omise/omise-php/blob/master/README.md

Place this code next to the line where the Omise-PHP library is loaded. Replace the placeholder values with your actual keys from the Opn Payments Dashboard.

```php
define('OMISE_PUBLIC_KEY', 'pkey_test_***');
define('OMISE_SECRET_KEY', 'skey_test_***');
```

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

### GET recipients/{id}/schedules

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves schedules for a specific recipient. Requires secret authentication.

```APIDOC
## GET {OMISE_API_URL}recipients/{id}/schedules?{options}

### Description
Retrieves schedules for a specific recipient. Requires secret authentication.

### Method
GET

### Endpoint
`{OMISE_API_URL}recipients/{id}/schedules?{options}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The recipient ID.

#### Query Parameters
- **options** (object) - Optional - Query options for filtering schedules.

### Response
#### Success Response (200)
- **schedules** (array) - List of schedule objects.

#### Response Example
{
  "schedules": []
}
```

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

### Create a source and poll until chargeable

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-source-token.md

Creates a source, echoes its ID and status, then retrieves it again.

```php
$source = OmiseSource::create([
    'type' => 'installment_2',
    'currency' => 'thb',
    'amount' => 200000,
]);

echo $source['id'];
echo $source['status']; // 'pending' / 'chargeable'

$fetched = OmiseSource::retrieve($source['id']);
```

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

### GET recipients

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a list of recipients or a specific recipient by ID. Requires secret authentication.

```APIDOC
## GET {OMISE_API_URL}recipients

### Description
Retrieves a list of recipients or a specific recipient by ID. Requires secret authentication.

### Method
GET

### Endpoint
`{OMISE_API_URL}recipients` or `{OMISE_API_URL}recipients/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - The recipient ID to retrieve a specific recipient.

### Response
#### Success Response (200)
- **recipients** (array) - List of recipient objects.

#### Response Example
{
  "recipients": []
}
```

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

### GET receipts

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a list of receipts or a specific receipt by ID. Requires secret authentication.

```APIDOC
## GET {OMISE_API_URL}receipts

### Description
Retrieves a list of receipts or a specific receipt by ID. Requires secret authentication.

### Method
GET

### Endpoint
`{OMISE_API_URL}receipts` or `{OMISE_API_URL}receipts/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - The receipt ID to retrieve a specific receipt.

### Response
#### Success Response (200)
- **receipts** (array) - List of receipt objects.

#### Response Example
{
  "receipts": []
}
```

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

### Static method create

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-dispute.md

Creates a dispute against a charge. Sends POST to {OMISE_API_URL}charges/{charge_id}/disputes via g_create. Throws Exception|OmiseException.

```php
public static function create($charge, $params, $publickey = null, $secretkey = null)
```

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

### GET links

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a list of links or a specific link by ID. Requires secret authentication.

```APIDOC
## [GET] links

### Description
Retrieves a list of links or a specific link by ID.

### Method
GET

### Endpoint
`{OMISE_API_URL}links` or `{OMISE_API_URL}links/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - The ID of the link to retrieve.

### Response
#### Success Response (200)
- **object** (string) - Type of object (e.g., "list").
- **data** (array) - Array of link objects.

#### Response Example
```json
{
  "object": "list",
  "data": [
    {
      "id": "link_test_123",
      "url": "https://example.com"
    }
  ]
}
```
```

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

### GET events

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a list of events or a specific event by ID. Requires secret authentication.

```APIDOC
## [GET] events

### Description
Retrieves a list of events or a specific event by ID.

### Method
GET

### Endpoint
`{OMISE_API_URL}events` or `{OMISE_API_URL}events/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - The ID of the event to retrieve.

### Response
#### Success Response (200)
- **object** (string) - Type of object (e.g., "list").
- **data** (array) - Array of event objects.

#### Response Example
```json
{
  "object": "list",
  "data": [
    {
      "id": "evt_test_123",
      "type": "charge.create"
    }
  ]
}
```
```

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

### PHP: Initialize Omise API keys and version

Source: https://github.com/omise/omise-php/blob/master/README.md

Sets the Omise public key, secret key, and API version constants required for all API requests. Place this at the top of your script after loading the Composer autoloader.

```php
<?php
require_once dirname(__FILE__).'/vendor/autoload.php';

define('OMISE_PUBLIC_KEY', 'pkey_test_***');
define('OMISE_SECRET_KEY', 'skey_test_***');
define('OMISE_API_VERSION', '2019-05-29');
```

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

### GET disputes

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a list of all disputes or a specific dispute by ID. Requires secret authentication.

```APIDOC
## [GET] disputes

### Description
Retrieves a list of all disputes or a specific dispute by ID.

### Method
GET

### Endpoint
`{OMISE_API_URL}disputes` or `{OMISE_API_URL}disputes/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - The ID of the dispute to retrieve.

### Response
#### Success Response (200)
- **object** (string) - Type of object (e.g., "list").
- **data** (array) - Array of dispute objects.

#### Response Example
```json
{
  "object": "list",
  "data": [
    {
      "id": "dsp_test_123",
      "status": "open"
    }
  ]
}
```
```

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

### GET {OMISE_API_URL}capability

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves the capability information. This endpoint is used by OmiseCapability::retrieve() and reload().

```APIDOC
## [GET] {OMISE_API_URL}capability

### Description
Retrieves the capability information.

### Method
GET

### Endpoint
{OMISE_API_URL}capability

### Authentication
secret

### Response
#### Success Response (200)
- Capability details

#### Response Example
{
  "example": "response body"
}
```

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

### GET {OMISE_API_URL}balance

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves the balance information. This endpoint is used by OmiseBalance::retrieve() and reload().

```APIDOC
## [GET] {OMISE_API_URL}balance

### Description
Retrieves the balance information.

### Method
GET

### Endpoint
{OMISE_API_URL}balance

### Authentication
secret

### Response
#### Success Response (200)
- Balance details

#### Response Example
{
  "example": "response body"
}
```

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

### OmiseForex::retrieve method

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Static method to retrieve foreign exchange data for a given currency.

```php
public static function retrieve($currency = '', $publickey = null, $secretkey = null)
```

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

### GET {OMISE_API_URL}account

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves the account information. This endpoint is used by OmiseAccount::retrieve() and reload().

```APIDOC
## [GET] {OMISE_API_URL}account

### Description
Retrieves the account information.

### Method
GET

### Endpoint
{OMISE_API_URL}account

### Authentication
secret

### Response
#### Success Response (200)
- Account details

#### Response Example
{
  "example": "response body"
}
```

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

### OmiseCard::__construct

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-card.md

Constructor for OmiseCard. Initializes a card resource with attributes, customer ID, and optional key overrides.

```APIDOC
## OmiseCard::__construct

### Description
Constructor for OmiseCard. Initializes a card resource with attributes, customer ID, and optional key overrides.

### Method
Constructor

### Signature
```php
public function __construct($array, $customerID, $publickey = null, $secretkey = null)
```

### Parameters
- **array** (array) - Required - Card attributes from the API.
- **customerID** (string) - Required - Owning customer ID (`cust_...`).
- **publickey** (string) - Optional - Public key override. Default: `null`.
- **secretkey** (string) - Optional - Secret key override. Default: `null`.

### Description
Calls the parent constructor, stores `_customerID`, and `refresh($array)`.
```

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

### Error handling for customer retrieval

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-customer.md

Shows how to catch OmiseNotFoundException and OmiseException when retrieving a non-existent customer.

```php
try {
    OmiseCustomer::retrieve('cust_does_not_exist');
} catch (OmiseNotFoundException $e) {
    $err = $e->getOmiseError();
    echo $err['code'];    // 'not_found'
    echo $err['message'];
} catch (OmiseException $e) {
    echo $e->getMessage();
}
```

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

### Instance method accept

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-dispute.md

Sends PATCH to {OMISE_API_URL}disputes/{id}/accept via g_update. Returns void.

```php
public function accept()
```

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

### OmiseForex class definition

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Defines the OmiseForex resource with endpoint 'forex'.

```php
class OmiseForex extends OmiseApiResource
{
    const ENDPOINT = 'forex';
}
```

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

### GET charges/{charge_id}/refunds/{refund_id}

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves a specific refund for a charge. Requires secret authentication.

```APIDOC
## GET {OMISE_API_URL}charges/{charge_id}/refunds/{refund_id}

### Description
Retrieves a specific refund for a charge. Requires secret authentication.

### Method
GET

### Endpoint
`{OMISE_API_URL}charges/{charge_id}/refunds/{refund_id}`

### Parameters
#### Path Parameters
- **charge_id** (string) - Required - The charge ID.
- **refund_id** (string) - Required - The refund ID.

### Response
#### Success Response (200)
- **refund** (object) - The refund object.

#### Response Example
{
  "refund": {}
}
```

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

### GET forex

Source: https://github.com/omise/omise-php/blob/master/_autodocs/endpoints.md

Retrieves forex rates for a specific currency or the base currency. Requires secret authentication.

```APIDOC
## [GET] forex

### Description
Retrieves forex rates for a specific currency or the base currency.

### Method
GET

### Endpoint
`{OMISE_API_URL}forex` or `{OMISE_API_URL}forex/{currency}`

### Parameters
#### Path Parameters
- **currency** (string) - Optional - The currency code (e.g., "usd").

### Response
#### Success Response (200)
- **base** (string) - Base currency.
- **rates** (object) - Exchange rates.

#### Response Example
```json
{
  "base": "thb",
  "rates": {
    "usd": 0.031
  }
}
```
```

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

### create

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-transfer.md

Creates a new transfer with the given parameters. Returns an OmiseTransfer instance.

```APIDOC
## create

### Description
Creates a new transfer with the given parameters. Returns an OmiseTransfer instance.

### Method
POST

### Endpoint
`{OMISE_API_URL}transfers`

### Parameters
#### Request Body
- `params` (mixed/array) - Required - Transfer attributes (e.g., `amount`, `currency`, `recipient`).

#### Query Parameters
- `publickey` (string) - Optional - Public key override.
- `secretkey` (string) - Optional - Secret key override.

### Response
#### Success Response (200)
- Returns `OmiseTransfer` instance.

#### Error Handling
Throws `Exception|OmiseException`.
```

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

### OmiseSource::retrieve

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-source-token.md

Retrieves a source by its ID. This method sends a GET request to the /sources endpoint using the public key.

```APIDOC
## [GET] /sources/{id}

### Description
Retrieves a source by its ID. This method sends a GET request to the /sources endpoint using the public key.

### Method
GET

### Endpoint
`{OMISE_API_URL}sources/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - Source ID (`src_...`).

#### Query Parameters
- **publickey** (string) - Optional - Public key override.
- **secretkey** (string) - Optional - Secret key override.

### Response
#### Success Response (200)
- **OmiseSource** - The source object.

#### Response Example
```json
{
  "id": "src_test_...",
  "type": "installment_2",
  "currency": "thb",
  "amount": 200000,
  "status": "chargeable"
}
```

### Error Handling
Throws `Exception|OmiseException`.
```

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

### create

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-recipient.md

Creates a new recipient with the provided attributes. This static method sends a POST request to the /recipients endpoint.

```APIDOC
## [POST] /recipients

### Description
Creates a new recipient with the provided attributes.

### Method
POST

### Endpoint
`{OMISE_API_URL}recipients`

### Parameters
#### Request Body
- **params** (array) - Required - Recipient attributes (e.g. `name`, `email`, `type`, bank account info).

### Request Example
```json
{
  "name": "John Doe",
  "email": "john@example.com",
  "type": "individual",
  "bank_account": {
    "brand": "bbl",
    "number": "1234567890",
    "name": "John Doe"
  }
}
```

### Response
#### Success Response (200)
- **OmiseRecipient** - The created recipient object.

#### Response Example
```json
{
  "object": "recipient",
  "id": "recp_...",
  "name": "John Doe",
  "email": "john@example.com",
  "type": "individual"
}
```

### Error Handling
Throws `Exception|OmiseException`.
```

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

### create

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-charge.md

Creates a new charge with the given parameters. This method wraps the POST /charges endpoint.

```APIDOC
## [POST] /charges

### Description
Creates a new charge with the given parameters.

### Method
POST

### Endpoint
`{OMISE_API_URL}charges`

### Parameters
#### Request Body
- **params** (array) - Required - Charge attributes (e.g. `amount`, `currency`, `card`, `customer`, `capture`, `return_uri`).
- **publickey** (string / null) - Optional - Public key override.
- **secretkey** (string / null) - Optional - Secret key override.

### Request Example
```json
{
  "amount": 1000,
  "currency": "thb",
  "card": "card_test_123"
}
```

### Response
#### Success Response (200)
- **OmiseCharge** - The created charge object.

#### Response Example
```json
{
  "object": "charge",
  "id": "chrg_test_4yq7duw4p1h1q2r8s0",
  "amount": 1000,
  "currency": "thb"
}
```

### Error Handling
Throws `Exception|OmiseException` on failure.
```

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

### OmiseCardList::retrieve

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-card.md

Retrieves a single card by ID. Sends a GET request to the card endpoint and returns an OmiseCard instance.

```APIDOC
## OmiseCardList::retrieve

### Description
Retrieves a single card by ID. Sends a GET request to the card endpoint and returns an OmiseCard instance.

### Method
GET

### Endpoint
`{OMISE_API_URL}customers/{customerID}/cards/{id}`

### Parameters
- **id** (string) - Required - Card ID (`card_...`).

### Returns
`OmiseCard` - Constructs a new OmiseCard with the result and the customer ID.
```

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

### Weekly and monthly schedules with bounded window

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-scheduler.md

Shows weekly and monthly schedules using OmiseTransfer::schedule and OmiseCharge::schedule, with startDate/endDate and month days_of_month options.

```php
$weekly = OmiseTransfer::schedule([
        'transfer[recipient]' => 'recp_test_***',
        'transfer[amount]' => 50000,
    ])
    ->every(2)
    ->weeks('Monday')
    ->startDate('2025-06-01')
    ->endDate('2025-12-31');

$weekly->start();

$monthly = OmiseCharge::schedule(['charge[customer]' => 'cust_test_***'])
    ->every(1)
    ->month(['days_of_month' => [1, 15]]) // or ->month([1, 15])
    ->startDate('2025-06-01');

$monthly->start();
```

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

### retrieve

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-recipient.md

Retrieves a recipient by ID or lists all recipients when no ID is provided. This static method sends a GET request to the /recipients endpoint.

```APIDOC
## [GET] /recipients/{id}

### Description
Retrieves a recipient by ID or lists all recipients when no ID is provided.

### Method
GET

### Endpoint
`{OMISE_API_URL}recipients/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Optional - Recipient ID (`recp_...`); empty fetches the list.

#### Query Parameters
- **publickey** (string) - Optional - Public key override.
- **secretkey** (string) - Optional - Secret key override.

### Response
#### Success Response (200)
- **OmiseRecipient** - The recipient object or list of recipients.

#### Response Example
```json
{
  "object": "recipient",
  "id": "recp_...",
  "name": "John Doe",
  "email": "john@example.com",
  "type": "individual"
}
```

### Error Handling
Throws `Exception|OmiseException`.
```

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

### retrieve

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-charge.md

Retrieves a single charge by ID, or fetches the list of charges when no ID is provided. This method wraps the GET /charges endpoint.

```APIDOC
## [GET] /charges/{id}

### Description
Retrieves a single charge by ID, or fetches the list of charges when no ID is provided.

### Method
GET

### Endpoint
`{OMISE_API_URL}charges/{id}` (or `{OMISE_API_URL}charges` for the list)

### Parameters
#### Path Parameters
- **id** (string) - Optional - Charge ID (`chrg_...`). When empty, fetches the list of charges.

#### Query Parameters
- **publickey** (string) - Optional - Public key override.
- **secretkey** (string) - Optional - Secret key override.

### Response
#### Success Response (200)
- **OmiseCharge** - The charge object or list of charges.

#### Response Example
```json
{
  "object": "charge",
  "id": "chrg_test_4yq7duw4p1h1q2r8s0"
}
```

### Error Handling
Throws `Exception|OmiseException` on failure.
```

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

### OmiseCapability constructor

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-capability.md

Constructor that calls the parent constructor and setupFilterShortcuts(), creating shortcut functions for payment method filters.

```php
public function __construct($publickey = null, $secretkey = null)
```

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

### Usage: retrieve customer, list cards, update card

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-card.md

Shows how to retrieve a customer, list its cards, fetch a single card by ID, and update its expiry. Uses OmiseCustomer::retrieve() and $customer->cards().

```php
$customer = OmiseCustomer::retrieve('cust_test_***');

// Cards embedded in the customer object, or fetched via $customer->cards([...]).
$cardList = $customer->cards();

// Fetch a single card by ID.
$card = $cardList->retrieve($customer['cards']['data'][0]['id']);
echo $card['last4'];
echo $card['brand']; // 'Visa', 'MasterCard', ...

// Update the card's expiry.
$card->update(['expiration_month' => 12, 'expiration_year' => 2031]);
```

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

### OmiseReceipt class definition

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-simple-resources.md

Defines the OmiseReceipt resource with endpoint 'receipts'.

```php
class OmiseReceipt extends OmiseApiResource
{
    const ENDPOINT = 'receipts';
}
```

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

### List all payment methods without filters

Source: https://github.com/omise/omise-php/blob/master/_autodocs/api-reference/omise-capability.md

Retrieves the capability and iterates over all payment methods, printing each method's name. Note that methods are cast to objects, while raw capability attributes remain accessible via array syntax.

```php
$capability = OmiseCapability::retrieve();
foreach ($capability->getPaymentMethods() as $method) {
    echo $method->name; // 'card', 'installment_xxx', 'alipay', ...
}
```
Tokens:
Raw