Xendit PHP

https://github.com/xendit/xendit-php
Admin
The official Xendit PHP SDK provides a simple and convenient way to call Xendit's REST API in...
Tokens:781,865
Snippets:5,553
Trust Score:9
License:MIT
Update:2 days ago
Show doc for...
Tokens:
Raw
### PHP Usage Example for getPayoutChannels()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PayoutApi.md

Complete PHP example that sets the API key, creates a PayoutApi instance, and calls getPayoutChannels() with example parameters. It prints the result or catches and displays a XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Payout\PayoutApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PayoutApi();
$currency = "IDR, PHP"; // string | Filter channels by currency from ISO-4217 values
$channel_category = array(new \Xendit\Payout\ChannelCategory()); // \Payout\ChannelCategory[] | Filter channels by category
$channel_code = "ID_MANDIRI, PH_GCASH"; // string | Filter channels by channel code, prefixed by ISO-3166 country code
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information.

try {
    $result = $apiInstance->getPayoutChannels($currency, $channel_category, $channel_code, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PayoutApi->getPayoutChannels: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### PaymentMethodCallback Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

Example of instantiating a PaymentMethodCallback object with sample data to illustrate its structure.

```APIDOC
## PaymentMethodCallback Object

### Description
Callback object for active or expired E-Wallet or Direct Debit account linking, Virtual Accounts or QR strings.

### Usage Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Xendit\PaymentMethod\PaymentMethodCallback;

$payment_method_callback = new PaymentMethodCallback([
  'event' => 'payment_method.activated',
  'data' => [
    'id' => 'pm-6ff0b6f2-f5de-457f-b08f-bc98fbae485a',
    'card' => null,
    'type' => 'DIRECT_DEBIT',
    'status' => 'ACTIVE',
    'country' => 'PH',
    'created' => '2022-08-12T13=>30=>26.579048Z',
    'ewallet' => null,
    'qr_code' => null,
    'updated' => '2022-08-12T13=>30=>58.908220358Z',
    'metadata' => null,
    'customer_id' => 'e2878b4c-d57e-4a2c-922d-c0313c2800a3',
    'description' => null,
    'reusability' => 'MULTIPLE_USE',
    'direct_debit' => [
      'type' => 'BANK_ACCOUNT',
      'debit_card' => null,
      'bank_account' => [
        'bank_account_hash' => 'b4dfa99c9b60c77f2e3962b73c098945',
        'masked_bank_account_number' => 'XXXXXX1234'
      ],
      'channel_code' => 'BPI',
      'channel_properties' => [
        'failure_return_url' => 'https://your-redirect-website.com/failure',
        'success_return_url' => 'https://your-redirect-website.com/success'
      ]
    ],
    'failure_code' => null,
    'reference_id' => '620b9df4-fe69-4bfd-b9d4-5cba6861db8a',
    'virtual_account' => null,
    'over_the_counter' => null,
    'billing_information' => null,
    'direct_bank_transfer' => null
  ],
  'created' => '2022-08-12T13=>30=>59.074277334Z',
  'business_id' => '5f27a14a9bf05c73dd040bc8'
]);
```

### Webhook Handler Usage
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

function simulatePaymentMethodCallback(PaymentMethodCallback $payment_method_callback) {
    echo $payment_method_callback->getId();
    // do things here with the callback
}
```
```

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

### Usage example for createRefund

Source: https://github.com/xendit/xendit-php/blob/master/docs/RefundApi.md

Complete example that calls createRefund with sample parameters and handles exceptions. Uses the XenditSdkException to print error details.

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string
$create_refund = new \Xendit\Refund\CreateRefund(); // \Xendit\Refund\CreateRefund

try {
    $result = $apiInstance->createRefund($idempotency_key, $for_user_id, $create_refund);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling RefundApi->createRefund: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### getAllRefunds() Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/RefundApi.md

PHP example that calls RefundApi->getAllRefunds with sample parameters and prints the result or catches a XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string
$payment_request_id = "'payment_request_id_example'"; // string
$invoice_id = "'invoice_id_example'"; // string
$payment_method_type = "'payment_method_type_example'"; // string
$channel_code = "'channel_code_example'"; // string
$limit = 3.4; // float
$after_id = "'after_id_example'"; // string
$before_id = "'before_id_example'"; // string

try {
    $result = $apiInstance->getAllRefunds($for_user_id, $payment_request_id, $invoice_id, $payment_method_type, $channel_code, $limit, $after_id, $before_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling RefundApi->getAllRefunds: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for getBalance()

Source: https://github.com/xendit/xendit-php/blob/master/docs/BalanceApi.md

Complete example of calling getBalance with sample parameters and handling exceptions. Demonstrates how to retrieve a balance and print the result or error.

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

use Xendit\Configuration;
use Xendit\BalanceAndTransaction\BalanceApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new BalanceApi();
$account_type = "CASH"; // string | The selected balance type
$currency = "IDR"; // string | Currency for filter for customers with multi currency accounts
$at_timestamp = 2020-06-19T00:00+07:00; // \DateTime | The timestamp you want to use as the limit for balance retrieval
$for_user_id = "5dbf20d7c8eb0c0896f811b6"; // string | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information

try {
    $result = $apiInstance->getBalance($account_type, $currency, $at_timestamp, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling BalanceApi->getBalance: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for createCustomer

Source: https://github.com/xendit/xendit-php/blob/master/docs/CustomerApi.md

Complete example of calling createCustomer with sample parameters and handling exceptions. Demonstrates how to set up the client, create a CustomerRequest, and catch XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Customer\CustomerApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new CustomerApi();
$idempotency_key = "idempotency-123"; // string | A unique key to prevent processing duplicate requests.
$for_user_id = "user-1"; // string | The sub-account user-id that you want to make this transaction for.
$customer_request = new \Xendit\Customer\CustomerRequest(); // \Xendit\Customer\CustomerRequest | Request object for end customer object

try {
    $result = $apiInstance->createCustomer($idempotency_key, $for_user_id, $customer_request);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling CustomerApi->createCustomer: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### getRefund() Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/RefundApi.md

PHP example that calls RefundApi->getRefund with sample parameters and prints the result or catches a XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string

try {
    $result = $apiInstance->getRefund($refund_id, $idempotency_key, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling RefundApi->getRefund: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### getCustomer usage example

Source: https://github.com/xendit/xendit-php/blob/master/docs/CustomerApi.md

Example of calling getCustomer with an id and for_user_id, printing the result or catching XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Customer\CustomerApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new CustomerApi();
$id = "d290f1ee-6c54-4b01-90e6-d701748f0851"; // string | End customer resource id
$for_user_id = "user-1"; // string | The sub-account user-id that you want to make this transaction for.

try {
    $result = $apiInstance->getCustomer($id, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling CustomerApi->getCustomer: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage Example for getAllPaymentMethods()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

Complete PHP example that initializes the SDK, sets the API key, and calls getAllPaymentMethods() with sample parameters. Catches XenditSdkException and prints the error details.

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

use Xendit\Configuration;
use Xendit\PaymentMethod\PaymentMethodApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentMethodApi();
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$id = array('id_example'); // string[]
$type = array('type_example'); // string[]
$status = array(new \Xendit\PaymentMethod\PaymentMethodStatus()); // \PaymentMethod\PaymentMethodStatus[]
$reusability = new \Xendit\PaymentMethod\PaymentMethodReusability(); // PaymentMethodReusability
$customer_id = "'customer_id_example'"; // string
$reference_id = "'reference_id_example'"; // string
$after_id = "'after_id_example'"; // string
$before_id = "'before_id_example'"; // string
$limit = 56; // int

try {
    $result = $apiInstance->getAllPaymentMethods($for_user_id, $id, $type, $status, $reusability, $customer_id, $reference_id, $after_id, $before_id, $limit);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentMethodApi->getAllPaymentMethods: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for cancelPayout()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PayoutApi.md

Example PHP code that initializes the API client and calls cancelPayout with sample parameters, handling exceptions.

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

use Xendit\Configuration;
use Xendit\Payout\PayoutApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PayoutApi();
$id = "disb-7baa7335-a0b2-4678-bb8c-318c0167f332"; // string | Payout id returned from the response of /v2/payouts
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information.

try {
    $result = $apiInstance->cancelPayout($id, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PayoutApi->cancelPayout: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for getAllPaymentRequests()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentRequestApi.md

Example of calling getAllPaymentRequests with sample parameters. Requires the Xendit PHP SDK and an API key. Catches XenditSdkException and prints the error details.

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$reference_id = array('reference_id_example'); // string[]
$id = array('id_example'); // string[]
$customer_id = array('customer_id_example'); // string[]
$limit = 56; // int
$before_id = "'before_id_example'"; // string
$after_id = "'after_id_example'"; // string

try {
    $result = $apiInstance->getAllPaymentRequests($for_user_id, $reference_id, $id, $customer_id, $limit, $before_id, $after_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->getAllPaymentRequests: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Instantiate PaymentMethodCallback with example data

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

Illustrates the contents of the PaymentMethodCallback object for an active E-Wallet or Direct Debit account linking event. This example is not meant to be instantiated in practice; it shows the structure of the callback data.

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

use Xendit\PaymentMethod\PaymentMethodCallback;

$payment_method_callback = new PaymentMethodCallback([
  'event' => 'payment_method.activated',
  'data' => [
    'id' => 'pm-6ff0b6f2-f5de-457f-b08f-bc98fbae485a',
    'card' => null,
    'type' => 'DIRECT_DEBIT',
    'status' => 'ACTIVE',
    'country' => 'PH',
    'created' => '2022-08-12T13=>30=>26.579048Z',
    'ewallet' => null,
    'qr_code' => null,
    'updated' => '2022-08-12T13=>30=>58.908220358Z',
    'metadata' => null,
    'customer_id' => 'e2878b4c-d57e-4a2c-922d-c0313c2800a3',
    'description' => null,
    'reusability' => 'MULTIPLE_USE',
    'direct_debit' => [
      'type' => 'BANK_ACCOUNT',
      'debit_card' => null,
      'bank_account' => [
        'bank_account_hash' => 'b4dfa99c9b60c77f2e3962b73c098945',
        'masked_bank_account_number' => 'XXXXXX1234'
      ],
      'channel_code' => 'BPI',
      'channel_properties' => [
        'failure_return_url' => 'https://your-redirect-website.com/failure',
        'success_return_url' => 'https://your-redirect-website.com/success'
      ]
    ],
    'failure_code' => null,
    'reference_id' => '620b9df4-fe69-4bfd-b9d4-5cba6861db8a',
    'virtual_account' => null,
    'over_the_counter' => null,
    'billing_information' => null,
    'direct_bank_transfer' => null
  ],
  'created' => '2022-08-12T13=>30=>59.074277334Z',
  'business_id' => '5f27a14a9bf05c73dd040bc8'
]);
```

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

### authPaymentMethod() Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

PHP example that initializes the SDK, creates a PaymentMethodApi instance, and calls authPaymentMethod with sample parameters. It prints the result or catches an XenditSdkException.

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

use Xendit\Configuration;
use Xendit\PaymentMethod\PaymentMethodApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentMethodApi();
$payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$payment_method_auth_parameters = new \Xendit\PaymentMethod\PaymentMethodAuthParameters(); // \Xendit\PaymentMethod\PaymentMethodAuthParameters

try {
    $result = $apiInstance->authPaymentMethod($payment_method_id, $for_user_id, $payment_method_auth_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentMethodApi->authPaymentMethod: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for patchPaymentMethod()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

Complete PHP example that initializes the Xendit client, creates a PaymentMethodApi instance, and calls patchPaymentMethod with sample parameters. It prints the result or catches and displays a XenditSdkException.

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

use Xendit\Configuration;
use Xendit\PaymentMethod\PaymentMethodApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentMethodApi();
$payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$payment_method_update_parameters = new \Xendit\PaymentMethod\PaymentMethodUpdateParameters(); // \Xendit\PaymentMethod\PaymentMethodUpdateParameters

try {
    $result = $apiInstance->patchPaymentMethod($payment_method_id, $for_user_id, $payment_method_update_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentMethodApi->patchPaymentMethod: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Bank or EWallet Payout usage example

Source: https://github.com/xendit/xendit-php/blob/master/docs/PayoutApi.md

Example of calling createPayout() with a CreatePayoutRequest for a bank payout. Requires setting your API key via Configuration::setXenditKey().

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

use Xendit\Configuration;
use Xendit\Payout\PayoutApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PayoutApi();
$idempotency_key = "DISB-1234"; // string | A unique key to prevent duplicate requests from pushing through our system. No expiration.
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information.
$create_payout_request = new Xendit\Payout\CreatePayoutRequest([
  'reference_id' => 'DISB-001',
  'currency' => 'PHP',
  'channel_code' => 'PH_BDO',
  'channel_properties' => [
    'account_holder_name' => 'John Doe',
    'account_number' => '000000'
  ],
  'amount' => 90000,
  'description' => 'Test Bank Payout',
  'type' => 'DIRECT_DISBURSEMENT'
]); // \Xendit\Payout\CreatePayoutRequest

try {
    $result = $apiInstance->createPayout($idempotency_key, $for_user_id, $create_payout_request);
        print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PayoutApi->createPayout: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for getAllTransactions()

Source: https://github.com/xendit/xendit-php/blob/master/docs/TransactionApi.md

A complete PHP example that initializes the SDK, sets the API key, creates a TransactionApi instance, and calls getAllTransactions() with sample parameters. It prints the result or catches and displays an XenditSdkException.

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

use Xendit\Configuration;
use Xendit\BalanceAndTransaction\TransactionApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new TransactionApi();
$for_user_id = "5dbf20d7c8eb0c0896f811b6"; // string | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information
$types = ["DISBURSEMENT","PAYMENT"]; // \BalanceAndTransaction\TransactionTypes[] | Transaction types that will be included in the result. Default is to include all transaction types
$statuses = ["SUCCESS","PENDING"]; // \BalanceAndTransaction\TransactionStatuses[] | Status of the transaction. Default is to include all status.
$channel_categories = ["BANK","INVOICE"]; // \BalanceAndTransaction\ChannelsCategories[] | Payment channels in which the transaction is carried out. Default is to include all channels.
$reference_id = "ref23232"; // string | To filter the result for transactions with matching reference given (case sensitive)
$product_id = "d290f1ee-6c54-4b01-90e6-d701748f0701"; // string | To filter the result for transactions with matching product_id (a.k.a payment_id) given (case sensitive)
$account_identifier = "123123123"; // string | Account identifier of transaction. The format will be different from each channel. For example, on `BANK` channel it will be account number and on `CARD` it will be masked card number.
$amount = 100; // float | Specific transaction amount to search for
$currency = new \Xendit\BalanceAndTransaction\Currency(); // Currency
$created = array('key' => new \Xendit\BalanceAndTransaction\DateRangeFilter()); // DateRangeFilter | Filter time of transaction by created date. If not specified will list all dates.
$updated = array('key' => new \Xendit\BalanceAndTransaction\DateRangeFilter()); // DateRangeFilter | Filter time of transaction by updated date. If not specified will list all dates.
$limit = 10; // float | number of items in the result per page. Another name for \"results_per_page\"
$after_id = "'after_id_example'"; // string
$before_id = "'before_id_example'"; // string

try {
    $result = $apiInstance->getAllTransactions($for_user_id, $types, $statuses, $channel_categories, $reference_id, $product_id, $account_identifier, $amount, $currency, $created, $updated, $limit, $after_id, $before_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling TransactionApi->getAllTransactions: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage example for updateCustomer()

Source: https://github.com/xendit/xendit-php/blob/master/docs/CustomerApi.md

Example of calling updateCustomer() with a customer ID, user ID, and a PatchCustomer object, handling exceptions with XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Customer\CustomerApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new CustomerApi();
$id = "d290f1ee-6c54-4b01-90e6-d701748f0851"; // string | End customer resource id
$for_user_id = "user-1"; // string | The sub-account user-id that you want to make this transaction for.
$patch_customer = new \Xendit\Customer\PatchCustomer(); // \Xendit\Customer\PatchCustomer | Update Request for end customer object

try {
    $result = $apiInstance->updateCustomer($id, $for_user_id, $patch_customer);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling CustomerApi->updateCustomer: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### PaymentCallback Object Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentRequestApi.md

Illustrates the structure of a PaymentCallback object for a successful payment. This example is for demonstration only; you do not need to instantiate these objects in practice.

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

use Xendit\PaymentRequest\PaymentCallback;

$payment_callback = new PaymentCallback([
  'event' => 'payment.succeeded',
  'data' => [
    'id' => 'ddpy-3cd658ae-25b9-4659-aa36-596ae41a809f',
    'amount' => 1000,
    'status' => 'SUCCEEDED',
    'country' => 'PH',
    'created' => '2022-08-12T13=>30=>40.9209Z',
    'updated' => '2022-08-12T13=>30=>58.729373Z',
    'currency' => 'PHP',
    'metadata' => [
      'sku' => 'ABCDEFGH'
    ],
    'customer_id' => 'c832697e-a62d-46fa-a383-24930b155e81',
    'reference_id' => '25cfd0f9-baee-44ca-9a12-6debe03f3c22',
    'payment_method' => [
      'id' => 'pm-951b1ad9-1fbb-4724-a744-8956ab6ed17f',
      'card' => null,
      'type' => 'DIRECT_DEBIT',
      'status' => 'ACTIVE',
      'created' => '2022-08-12T13=>30=>26.579048Z',
      'ewallet' => null,
      'qr_code' => null,
      'updated' => '2022-08-12T13=>30=>40.221525Z',
      'metadata' => [
        'sku' => 'ABCDEFGH'
      ],
      'description' => null,
      'reusability' => 'MULTIPLE_USE',
      'direct_debit' => [
        'type' => 'BANK_ACCOUNT',
        'debit_card' => null,
        'bank_account' => [
          'bank_account_hash' => 'b4dfa99c9b60c77f2e3962b73c098945',
          'masked_bank_account_number' => 'XXXXXX1234'
        ],
        'channel_code' => 'BPI',
        'channel_properties' => [
          'failure_return_url' => 'https://your-redirect-website.com/failure',
          'success_return_url' => 'https://your-redirect-website.com/success'
        ]
      ],
      'reference_id' => '620b9df4-fe69-4bfd-b9d4-5cba6861db8a',
      'virtual_account' => null,
      'over_the_counter' => null,
      'direct_bank_transfer' => null
    ],
    'description' => null,
    'failure_code' => null,
    'payment_detail' => null,
    'channel_properties' => null,
    'payment_request_id' => 'pr-5b26cae1-545b-49e9-855e-f85128f3e705'
  ],
  'created' => '2022-08-12T13=>30=>58.986Z',
  'business_id' => '5f27a14a9bf05c73dd040bc8',
  'api_version' => null
]);

```

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

### Usage example for authorizePaymentRequest()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentRequestApi.md

PHP example that initializes the Xendit client, creates a PaymentRequestApi instance, and calls authorizePaymentRequest() with sample parameters. Catches XenditSdkException and prints the error.

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$payment_request_auth_parameters = new \Xendit\PaymentRequest\PaymentRequestAuthParameters(); // \Xendit\PaymentRequest\PaymentRequestAuthParameters

try {
    $result = $apiInstance->authorizePaymentRequest($payment_request_id, $for_user_id, $payment_request_auth_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->authorizePaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### PHP usage example for expirePaymentMethod()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

Example of calling expirePaymentMethod() with the Xendit PHP SDK. Requires an API key set via Configuration::setXenditKey(). The example creates a PaymentMethodExpireParameters object and handles exceptions with XenditSdkException.

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

use Xendit\Configuration;
use Xendit\PaymentMethod\PaymentMethodApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentMethodApi();
$payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$payment_method_expire_parameters = new \Xendit\PaymentMethod\PaymentMethodExpireParameters(); // \Xendit\PaymentMethod\PaymentMethodExpireParameters

try {
    $result = $apiInstance->expirePaymentMethod($payment_method_id, $for_user_id, $payment_method_expire_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentMethodApi->expirePaymentMethod: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### Usage Example for resendPaymentRequestAuth()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentRequestApi.md

Example of calling resendPaymentRequestAuth with a payment request ID and user ID, handling exceptions with XenditSdkException.

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string

try {
    $result = $apiInstance->resendPaymentRequestAuth($payment_request_id, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->resendPaymentRequestAuth: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

```

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

### Add Xendit PHP SDK to composer.json

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

Add the Xendit PHP SDK repository and requirement to your composer.json file. Then run 'composer install' to install the bindings.

```json
{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/xendit/xendit-php.git"
    }
  ],
  "require": {
    "xendit/xendit-php": "7.0.0"
  }
}
```

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

### getPayoutById() Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/PayoutApi.md

PHP example demonstrating how to call getPayoutById with an API key, payout ID, and optional for_user_id. It prints the result or catches an XenditSdkException.

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

use Xendit\Configuration;
use Xendit\Payout\PayoutApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PayoutApi();
$id = "disb-7baa7335-a0b2-4678-bb8c-318c0167f332"; // string | Payout id returned from the response of /v2/payouts
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string | The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information.

try {
    $result = $apiInstance->getPayoutById($id, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PayoutApi->getPayoutById: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### PHP usage example for simulatePayment()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentMethodApi.md

Example of calling simulatePayment() with a payment method ID and a SimulatePaymentRequest object. Requires the Xendit SDK and an API key. Catches XenditSdkException and prints the error message and full error details.

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

use Xendit\Configuration;
use Xendit\PaymentMethod\PaymentMethodApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentMethodApi();
$payment_method_id = "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$simulate_payment_request = new \Xendit\PaymentMethod\SimulatePaymentRequest(); // \Xendit\PaymentMethod\SimulatePaymentRequest

try {
    $apiInstance->simulatePayment($payment_method_id, $simulate_payment_request);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentMethodApi->simulatePayment: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

```

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

### getInvoices() Usage Example

Source: https://github.com/xendit/xendit-php/blob/master/docs/InvoiceApi.md

PHP example that calls getInvoices with all optional parameters. It sets the API key, creates an InvoiceApi instance, and catches XenditSdkException to print the error message and full error details.

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

use Xendit\Configuration;
use Xendit\Invoice\InvoiceApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new InvoiceApi();
$for_user_id = "62efe4c33e45694d63f585f0"; // string | Business ID of the sub-account merchant (XP feature)
$external_id = "test-external"; // string
$statuses = ["PENDING","SETTLED"]; // \Invoice\InvoiceStatus[]
$limit = 10; // float
$created_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$created_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$paid_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$paid_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$expired_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$expired_before = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$last_invoice = "62efe4c33e45294d63f585f2"; // string
$client_types = ["API_GATEWAY","DASHBOARD"]; // \Invoice\InvoiceClientType[]
$payment_channels = ["BNI","BRI"]; // string[]
$on_demand_link = "test-link"; // string
$recurring_payment_id = "62efe4c33e45294d63f585f2"; // string

try {
    $result = $apiInstance->getInvoices($for_user_id, $external_id, $statuses, $limit, $created_after, $created_before, $paid_after, $paid_before, $expired_after, $expired_before, $last_invoice, $client_types, $payment_channels, $on_demand_link, $recurring_payment_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling InvoiceApi->getInvoices: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### PHP usage example for capturePaymentRequest()

Source: https://github.com/xendit/xendit-php/blob/master/docs/PaymentRequestApi.md

Complete example of calling capturePaymentRequest() with the Xendit PHP SDK. Requires an API key, sets up the PaymentRequestApi instance, and handles exceptions with XenditSdkException.

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$capture_parameters = new \Xendit\PaymentRequest\CaptureParameters(); // \Xendit\PaymentRequest\CaptureParameters

try {
    $result = $apiInstance->capturePaymentRequest($payment_request_id, $for_user_id, $capture_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->capturePaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```

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

### cancelRefund() usage example

Source: https://github.com/xendit/xendit-php/blob/master/docs/RefundApi.md

Example of calling cancelRefund with a refund ID, idempotency key, and for_user_id. Requires an API key set via Configuration::setXenditKey. Catches XenditSdkException and prints the error.

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string

try {
    $result = $apiInstance->cancelRefund($refund_id, $idempotency_key, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling RefundApi->cancelRefund: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}
```
Tokens:
Raw