76 lines
1.7 KiB
Markdown
76 lines
1.7 KiB
Markdown
|
||
|
||
# Xendit PHP SDK
|
||
|
||
The official Xendit PHP SDK provides a simple and convenient way to call Xendit's REST API
|
||
in applications written in PHP.
|
||
|
||
* Package version: 5.0.0
|
||
|
||
# Getting Started
|
||
|
||
## Installation
|
||
|
||
### Requirements
|
||
|
||
PHP 7.4 and later.
|
||
|
||
### Composer
|
||
|
||
To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:
|
||
|
||
```json
|
||
{
|
||
"repositories": [
|
||
{
|
||
"type": "vcs",
|
||
"url": "https://github.com/xendit/xendit-php.git"
|
||
}
|
||
],
|
||
"require": {
|
||
"xendit/xendit-php": "5.0.0"
|
||
}
|
||
}
|
||
```
|
||
|
||
Then run `composer install`
|
||
|
||
### Autoloading
|
||
|
||
Download the files and include `autoload.php`:
|
||
|
||
```php
|
||
<?php
|
||
require_once(__DIR__ . '/vendor/autoload.php');
|
||
```
|
||
|
||
## Authorization
|
||
|
||
The SDK needs to be instantiated using your secret API key obtained from the [Xendit Dashboard](https://dashboard.xendit.co/settings/developers#api-keys).
|
||
You can sign up for a free Dashboard account [here](https://dashboard.xendit.co/register).
|
||
|
||
```php
|
||
use Xendit\Configuration;
|
||
|
||
Configuration::setXenditKey('XENDIT_API_KEY');
|
||
```
|
||
|
||
# Documentation
|
||
|
||
Find detailed API information and examples for each of our product’s by clicking the links below,
|
||
|
||
* [Invoice](docs/InvoiceApi.md)
|
||
* [PaymentRequest](docs/PaymentRequestApi.md)
|
||
* [PaymentMethod](docs/PaymentMethodApi.md)
|
||
* [Refund](docs/RefundApi.md)
|
||
* [Balance](docs/BalanceApi.md)
|
||
* [Transaction](docs/TransactionApi.md)
|
||
* [Customer](docs/CustomerApi.md)
|
||
* [Payout](docs/PayoutApi.md)
|
||
|
||
All URIs are relative to *https://api.xendit.co*. For more information about our API, please refer to *https://developers.xendit.co/*.
|
||
|
||
Further Reading
|
||
|
||
* [Xendit Docs](https://docs.xendit.co/)
|
||
* [Xendit API Reference](https://developers.xendit.co/) |